v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Branding Endpoints

partner/branding-details

This endpoint allows you to fetch your existing branding details.

get/partner/branding-details

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Productstring required

The product you want to fetch branding details for. Valid options are: portal, email, elinx, onboarding, asp.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Logostring

Base64 encoded logo image.

LogoUrlstring

URL of the logo image.

SmallLogostring

Base64 encoded logo image.

SmallLogoUrlstring

URL of the logo image.

Example response

{
  "BrandingDetails": {
    "PrimaryColor": "#FF0000",
    "SecondaryColor": "#FF0000",
    "TextColor": "#FF0000",
    "ButtonTextColor": "#FF0000",
    "Product": "portal"
  },
  "Logo": "SGVsbG8gV29ybGQh",
  "LogoUrl": "https://example.com/logo.svg",
  "SmallLogo": "SGVsbG8gV29ybGQh",
  "SmallLogoUrl": "https://example.com/logo.svg"
}