Get white label config

Companies

APIs to onboard and manage company.

Operations

Updates white label config

Request

This endpoint stores white label config for the company at different entity levels.

Security

Bearer

Path

companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947

Query

companyRolestring(CompanyRole)required

Role of the company.

Enum"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"

Example: companyRole=ORG

Bodyapplication/jsonrequired

companyNamestring

Example: "Spotnana"

colorsobject(ColorWhiteLabelConfig)

Whitelabel configuration related to colours.

webLinksobject(WebLinksConfig)

Weblinks which are parts of WhiteLabelConfig.

fromEmailAddressstring

Example: "no-reply@spotnana.com"

fontFamilystring

Default "Arial"

Example: "Arial"

emailFontFamilystring

Default "Roboto"

Example: "Roboto"

fontFamilyCssstring

Example: "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css"

emailClientConfigobject(EmailClientConfig)

Email client configuration representing the email provider to be used.

clientRoutingBasePathstring

Base path used by Spotnana OBT application to invoke API calls. Default path value is /

routingConfigobject(RoutingConfig)

App routing configuration.

privacyDisclaimerobject(PrivacyDisclaimer)

Html to shown on the the login page. This will be text with hyper links.

visaRequirementsstring

Rich text content for visa requirements information

Example: "<p>Please ensure you have the necessary visa documentation before traveling.</p>"

themeConfigobject(ThemeConfigV2)

Theming V2 — additive, opt-in. Unset falls back to V1 (colors / fontFamily).

brandingVisibilityobject(BrandingVisibility)

Per-surface visibility of branding elements (e.g. hide the company logo on web but keep it in email). Additive — default shows everything.

emailTemplatesConfigobject(EmailTemplatesConfig)

Per-tenant email template overrides. Unset falls back to the generic template for each email.

curl -i -X PUT \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/white-label-config?companyRole=ORG' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyName": "Spotnana",
    "colors": {
      "primary": "#D33B47",
      "primaryDark": "#D33B47",
      "primaryLight": "#D33B47",
      "primaryPale": "#D33B47",
      "onPrimary": "#D33B47",
      "secondary": "#D33B47",
      "secondaryDark": "#D33B47",
      "secondaryLight": "#D33B47",
      "secondaryPale": "#D33B47",
      "onSecondary": "#D33B47",
      "error": "#D33B47",
      "errorDark": "#D33B47",
      "errorLight": "#D33B47",
      "errorPale": "#D33B47",
      "onError": "#D33B47"
    },
    "webLinks": {
      "logoHeader": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/confirmation/spotnana3.png",
      "logoFooter": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
      "companyWebsiteAddress": "https://www.spotnana.com",
      "homePage": "https://stage-app.spotnana.com/flights",
      "itineraryPage": "https://stage-app.spotnana.com/trips/3375488451",
      "disclaimerPage": "https://www.spotnana.com/terms",
      "privacyPage": "https://www.spotnana.com/privacy-policy",
      "hardApprovalUrl": "https://stage-app.spotnana.com/hardapproval?approvalId=CgozMzQ5OTI4MzI2EiMKIQoMCgpQaWh1IEd1cHRhEhFwaWh1QHNwb3RuYW5hLmNvbQ%3D%3D&approverName=Pihu%20Gupta&travelerName=Pihu%20Gupta&tripName=TESting%201&tripId=2418132231&voidDate=Tuesday,%2021%20Jun%20at%2002:00%20UTC",
      "itineraryFlightStatsUrl": "https://stage-app.spotnana.com/trips/4694735622",
      "appEmbedScriptUrl": "https://customjs.partner.com",
      "logoNavigationLink": "http://www.spotnana.com",
      "illustration": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
      "poweredBySpotnana": false,
      "logoutRedirectUrl": "https://www.spotnana.com/signout",
      "faviconUrl": "http://www.spotnana.com",
      "appDownloadLinks": {
        "androidPlayStoreUrl": "https://play.google.com/store/apps/details?id=com.spotnana",
        "iosAppStoreUrl": "https://apps.apple.com/in/app/spotnana-travel-booking/id1580021446",
        "qrCodeUrl": "https://www.spotnana.com"
      },
      "socialMediaLinks": {
        "facebookUrl": "https://www.facebook.com/spotnanaofficial",
        "twitterUrl": "https://twitter.com/spotnana",
        "instagramUrl": "https://www.instagram.com/spotnana_official"
      },
      "termsOfUse": "https://www.spotnana.com/terms/",
      "illustrationActionUrl": "https://www.spotnana.com/login",
      "checkoutCoverImageUrl": "https://duploservices-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
      "postCcVerificationCallbackUrl": "https://example.com/callback",
      "loyaltyLinkedImageUrl": "https://example.com/loyalty-linked.png",
      "onboardingFinalizeImageUrl": "https://example.com/onboarding-finalize.png",
      "inviteUserImageUrl": "https://example.com/invite-user.png",
      "enrollmentSuccessImageUrl": "https://example.com/enrollment-success.png",
      "takeActionPath": "https://partner.com/embedded/take-action",
      "bookMyTripPath": "https://partner.com/embedded/my-trip",
      "viewEventDetailsPath": "https://partner.com/embedded/my-trip",
      "downloadPath": "https://partner.com/embedded/download/%s"
    },
    "fromEmailAddress": "no-reply@spotnana.com",
    "fontFamily": "Arial",
    "emailFontFamily": "Roboto",
    "fontFamilyCss": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css",
    "emailClientConfig": {
      "client": "SENDGRID",
      "credentials": {
        "emailClientSecretKey": {
          "secretKey": "SECRET_KEY",
          "versionId": "1"
        }
      },
      "defaultSenderAddress": "test@somedomain.com",
      "defaultSenderName": "Test Sender"
    },
    "clientRoutingBasePath": "string",
    "routingConfig": {
      "appHomeRoute": "/my-account"
    },
    "privacyDisclaimer": {
      "show": true,
      "html": "</html>"
    },
    "visaRequirements": "<p>Please ensure you have the necessary visa documentation before traveling.</p>",
    "themeConfig": {
      "fontFamily": [
        "Inter",
        "Arial",
        "sans-serif"
      ],
      "palette": {
        "light": {
          "bg": {
            "surface": "#FFFFFF",
            "surface02": "#F7F7F7",
            "brand": "#D33B47",
            "brandSubtle": "#FBE9EA",
            "brandHover": "#B73039",
            "hover": "#F0F0F0"
          },
          "text": {
            "primary": "#1A1A1A",
            "secondary": "#6B6B6B",
            "brand": "#D33B47",
            "link": "#1F6FEB"
          },
          "border": {
            "light": "#E5E5E5",
            "medium": "#CCCCCC",
            "dark": "#999999",
            "brand": "#D33B47",
            "brandSubtle": "#F3C6C9",
            "hover": "#B73039"
          },
          "icon": {
            "brand": "#D33B47"
          },
          "appShell": {
            "bg": "#232F3E",
            "bgHover": "#33475B",
            "text": "#C9CBCF",
            "textHover": "#FFFFFF"
          },
          "tabs": {
            "underlineColor": "#D33B47",
            "hoverColor": "#F3C6C9"
          },
          "link": {
            "color": "#D33B47"
          }
        },
        "dark": {
          "bg": {
            "surface": "#FFFFFF",
            "surface02": "#F7F7F7",
            "brand": "#D33B47",
            "brandSubtle": "#FBE9EA",
            "brandHover": "#B73039",
            "hover": "#F0F0F0"
          },
          "text": {
            "primary": "#1A1A1A",
            "secondary": "#6B6B6B",
            "brand": "#D33B47",
            "link": "#1F6FEB"
          },
          "border": {
            "light": "#E5E5E5",
            "medium": "#CCCCCC",
            "dark": "#999999",
            "brand": "#D33B47",
            "brandSubtle": "#F3C6C9",
            "hover": "#B73039"
          },
          "icon": {
            "brand": "#D33B47"
          },
          "appShell": {
            "bg": "#232F3E",
            "bgHover": "#33475B",
            "text": "#C9CBCF",
            "textHover": "#FFFFFF"
          },
          "tabs": {
            "underlineColor": "#D33B47",
            "hoverColor": "#F3C6C9"
          },
          "link": {
            "color": "#D33B47"
          }
        }
      },
      "overrides": {
        "button": {
          "borderRadius": {
            "cornerShapeId": "SOFT"
          },
          "textTransform": "UPPERCASE"
        },
        "ghostButton": {
          "textTransform": "UPPERCASE"
        },
        "tabs": {
          "textTransform": "UPPERCASE"
        },
        "link": {
          "textTransform": "UPPERCASE"
        }
      },
      "shape": {
        "cornerShapeId": "SOFT"
      }
    },
    "brandingVisibility": {
      "headerLogo": {
        "hideOnWeb": true
      },
      "poweredBy": {
        "hideOnWeb": true
      }
    },
    "emailTemplatesConfig": {
      "onboardingTemplateName": "ONBOARDING_INVITATION"
    }
  }'

Responses

OK

Response

No content