WhiteLabel

The WhiteLabel object in Space Invoices enables you to configure the settings for your white-label UI deployment. This includes customizing links and controlling the visibility of interface elements and menu items. By using the WhiteLabel object, you can tailor the user interface to suit your branding requirements and create a seamless experience for your users within the white-labeled environment.

Please contact us to get started with your White Label deployment.

Endpoints:

  • GET /v1/WhiteLabels
  • PATCH /v1/WhiteLabels/:id

The WhiteLabel object

Parameters

  • id string readonly

  • active boolean

  • name string

    Name of your White Label instance.

  • domain string

    Your domain for Apollo white label implementation.

  • subdomain string

    Apollo subdomain for testing white label implemention.

  • baseColor string

  • logo string

  • separateDashboardIcon boolean

    Should a separate icon for dashboard be used in the sidebar instead of the logo serving as the button.

  • googleAnalyticsId string

    Google analytics tracking code.

  • chatAppType string

    Type of chat app to display. Currently Intercom and Tidio are supported out of the box.

  • chatAppId string

    Intercom or other chat app ID

  • privacyPolicyLink string

    URL to redirect user to if clicks on Terms of Service link in sidebar. Defaults to Website URL if not provided.

  • termsOfServiceLink string

    URL to redirect user to if clicks on Terms of Service link in sidebar. Defaults to Website URL if not provided.

  • websiteURL string

    URL to redirect user to if clicks on Website link in sidebar. Hidden if not provided.

  • supportEmail string

    Support email to display to user if clicks on Email link in sidebar. Hidden if not provided.

  • supportPhone string

    Support phone number to display to user if clicks on Call us link in sidebar. Hidden if not provided.

  • blogURL string

    URL to redirect user to if clicks on Blog link in sidebar. Hidden if not provided.

  • hideLoginPage boolean

    Should the Login page be hidden to users. If disabled the Uanuthorized redirect URL has to be provided.

  • showSignup boolean

    Should the Signup button be shown on the login page.

  • unauthorizedRedirectURL string

    URL to redirect user to in case of unauthorized in app. Used only if Login page is not displayed.

  • passwordResetURL string

    URL to redirect user to when clicking on Signup link. Only visible on Login page if it's displayed.

  • signupURL string

    URL to redirect user to when clicking on Signup link. Only visible on Login page if it's displayed.

  • allowInPromo boolean

    Allow Space Invoices to showcase your brand in our promo materials. ie. website, blog, newsletter etc.

  • interface object

    Allows hiding specific interface elements like menus and menu items.

  • subscriptionId string

    • Additional propertiesExpand all 
    
      {
  "active": false,
  "name": "string",
  "domain": "string",
  "subdomain": "string",
  "baseColor": "string",
  "logo": "string",
  "separateDashboardIcon": false,
  "googleAnalyticsId": "string",
  "chatAppType": "Intercom",
  "chatAppId": "string",
  "privacyPolicyLink": "string",
  "termsOfServiceLink": "string",
  "websiteURL": "string",
  "supportEmail": "string",
  "supportPhone": "string",
  "blogURL": "string",
  "hideLoginPage": true,
  "showSignup": false,
  "unauthorizedRedirectURL": "string",
  "passwordResetURL": "string",
  "signupURL": "string",
  "allowInPromo": true,
  "interface": {},
  "id": "string",
  "subscriptionId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z"
}

Find WhiteLabels

GET /v1/WhiteLabels

Parameters

Query

  • filter string optional

    Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string (`{"where":{"something":"value"}}`). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

      
        const response = await fetch('https://api.spaceinvoices.com/v1/WhiteLabels', {
  method: 'GET',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X GET https://api.spaceinvoices.com/v1/WhiteLabels \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/WhiteLabels'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      [
  {
    "active": false,
    "name": "string",
    "domain": "string",
    "subdomain": "string",
    "baseColor": "string",
    "logo": "string",
    "separateDashboardIcon": false,
    "googleAnalyticsId": "string",
    "chatAppType": "Intercom",
    "chatAppId": "string",
    "privacyPolicyLink": "string",
    "termsOfServiceLink": "string",
    "websiteURL": "string",
    "supportEmail": "string",
    "supportPhone": "string",
    "blogURL": "string",
    "hideLoginPage": true,
    "showSignup": false,
    "unauthorizedRedirectURL": "string",
    "passwordResetURL": "string",
    "signupURL": "string",
    "allowInPromo": true,
    "interface": {},
    "id": "string",
    "subscriptionId": "string",
    "createdAt": "2022-04-20T10:10:30+00:00Z",
    "updatedAt": "2022-04-20T10:10:30+00:00Z"
  }
]

Patch WhiteLabel

PATCH /v1/WhiteLabels/:id

Parameters

Path

  • id string required

    WhiteLabel id

Properties

  • active boolean optional

    Default is: false

  • name string optional

    Name of your White Label instance.

  • domain string optional

    Your domain for Apollo white label implementation.

  • subdomain string optional

    Apollo subdomain for testing white label implemention.

  • baseColor string optional

  • logo string optional

  • separateDashboardIcon boolean optional

    Default is: false

    Should a separate icon for dashboard be used in the sidebar instead of the logo serving as the button.

  • googleAnalyticsId string optional

    Google analytics tracking code.

  • chatAppType string optional

    Default is: Intercom

    Type of chat app to display. Currently Intercom and Tidio are supported out of the box.

  • chatAppId string optional

    Intercom or other chat app ID

  • privacyPolicyLink string optional

    URL to redirect user to if clicks on Terms of Service link in sidebar. Defaults to Website URL if not provided.

  • termsOfServiceLink string optional

    URL to redirect user to if clicks on Terms of Service link in sidebar. Defaults to Website URL if not provided.

  • websiteURL string optional

    URL to redirect user to if clicks on Website link in sidebar. Hidden if not provided.

  • supportEmail string optional

    Support email to display to user if clicks on Email link in sidebar. Hidden if not provided.

  • supportPhone string optional

    Support phone number to display to user if clicks on Call us link in sidebar. Hidden if not provided.

  • blogURL string optional

    URL to redirect user to if clicks on Blog link in sidebar. Hidden if not provided.

  • hideLoginPage boolean optional

    Default is: true

    Should the Login page be hidden to users. If disabled the Uanuthorized redirect URL has to be provided.

  • showSignup boolean optional

    Default is: false

    Should the Signup button be shown on the login page.

  • unauthorizedRedirectURL string optional

    URL to redirect user to in case of unauthorized in app. Used only if Login page is not displayed.

  • passwordResetURL string optional

    URL to redirect user to when clicking on Signup link. Only visible on Login page if it's displayed.

  • signupURL string optional

    URL to redirect user to when clicking on Signup link. Only visible on Login page if it's displayed.

  • allowInPromo boolean optional

    Default is: true

    Allow Space Invoices to showcase your brand in our promo materials. ie. website, blog, newsletter etc.

  • interface object optional

    Allows hiding specific interface elements like menus and menu items.

  • subscriptionId string optional 

      
        const response = await fetch('https://api.spaceinvoices.com/v1/WhiteLabels/{id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    active: false,
    name: 'string',
    domain: 'string',
    subdomain: 'string',
    baseColor: 'string',
    logo: 'string',
    separateDashboardIcon: false,
    googleAnalyticsId: 'string',
    chatAppType: 'Intercom',
    chatAppId: 'string',
    privacyPolicyLink: 'string',
    termsOfServiceLink: 'string',
    websiteURL: 'string',
    supportEmail: 'string',
    supportPhone: 'string',
    blogURL: 'string',
    hideLoginPage: true,
    showSignup: false,
    unauthorizedRedirectURL: 'string',
    passwordResetURL: 'string',
    signupURL: 'string',
    allowInPromo: true,
    interface: {},
    subscriptionId: 'string'
  })
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X PATCH https://api.spaceinvoices.com/v1/WhiteLabels/{id} \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "active": false, \
    "name": "string", \
    "domain": "string", \
    "subdomain": "string", \
    "baseColor": "string", \
    "logo": "string", \
    "separateDashboardIcon": false, \
    "googleAnalyticsId": "string", \
    "chatAppType": "Intercom", \
    "chatAppId": "string", \
    "privacyPolicyLink": "string", \
    "termsOfServiceLink": "string", \
    "websiteURL": "string", \
    "supportEmail": "string", \
    "supportPhone": "string", \
    "blogURL": "string", \
    "hideLoginPage": true, \
    "showSignup": false, \
    "unauthorizedRedirectURL": "string", \
    "passwordResetURL": "string", \
    "signupURL": "string", \
    "allowInPromo": true, \
    "interface": {}, \
    "subscriptionId": "string"
  }'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/WhiteLabels/{id}'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {
  'active': False,
  'name': 'string',
  'domain': 'string',
  'subdomain': 'string',
  'baseColor': 'string',
  'logo': 'string',
  'separateDashboardIcon': False,
  'googleAnalyticsId': 'string',
  'chatAppType': 'Intercom',
  'chatAppId': 'string',
  'privacyPolicyLink': 'string',
  'termsOfServiceLink': 'string',
  'websiteURL': 'string',
  'supportEmail': 'string',
  'supportPhone': 'string',
  'blogURL': 'string',
  'hideLoginPage': True,
  'showSignup': False,
  'unauthorizedRedirectURL': 'string',
  'passwordResetURL': 'string',
  'signupURL': 'string',
  'allowInPromo': True,
  'interface': {},
  'subscriptionId': 'string'
}
response = requests.patch(url, json=params, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "active": false,
  "name": "string",
  "domain": "string",
  "subdomain": "string",
  "baseColor": "string",
  "logo": "string",
  "separateDashboardIcon": false,
  "googleAnalyticsId": "string",
  "chatAppType": "Intercom",
  "chatAppId": "string",
  "privacyPolicyLink": "string",
  "termsOfServiceLink": "string",
  "websiteURL": "string",
  "supportEmail": "string",
  "supportPhone": "string",
  "blogURL": "string",
  "hideLoginPage": true,
  "showSignup": false,
  "unauthorizedRedirectURL": "string",
  "passwordResetURL": "string",
  "signupURL": "string",
  "allowInPromo": true,
  "interface": {},
  "id": "string",
  "subscriptionId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z"
}