API Reference

Create branding

post
https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id//branding

Creates branding.

Path Params
string
required

Tenant identifier.

Body Params
string
required

Brand name.

string
required

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

boolean

Multi-language branding.

boolean

Set skipSponsorEditorAssignment = true if you do not want to allow Subscription owners to "auto-add" themselves as "sd_editor".

boolean

True if you want to restrict the Hangers (recordType) for this branding, False if you want to add the custom Hangers from the default brandCode of the Tenant.

boolean

Allow bypassing of Drawer creation.

string
enum

Locale in [ISO 639-1]-[ISO 3166-1] format.

Allowed:
boolean

Hide default Hangers (recordType).

boolean

Hide Folders (record).

boolean

Hide Collaborators.

primaryLogoExpanded
object
required

Primary logo expanded image URL.

primaryLogoContracted
object
required

Primary logo contracted image URL.

secondaryLogo
object
required

Secondary logo image URL.

primaryIsoLogo
object
required

Primary ISO logo image URL.

secondaryIsoLogo
object
required

Secondary ISO logo image URL.

topBanner
object
required

Top Banner Image URL.

emailHeaderBanner
object
required

Email header banner image URL.

string
required

Footer message.

string

Web app root.

styleSheet
object
required

StyleSheet details.

vCard
object
required

vCard Detail.

appSections
object

App sections.

boolean

Social login on Universal Login screen.

socialIdps
array of strings

Social Identity Providers.

socialIdps
universalRecordTypes
object
required

Universal Folder (record) types.

string

Identity Provider Redirect URL.

metadata
object

Metadata (key-value pairs).

boolean
Defaults to false

Skip subdomain creation.

string

Identifier of template to apply.

string
enum

Minimum identity provider MFA.

Allowed:
authFlows
object

Auth flows.

allowCommentsForEntity
array of strings

Allow comments for specific entities.

allowCommentsForEntity
invitationHashSettings
object

Invitation Hash settings.

manualOtpSettings
object

Manual otp settings.

registrationSettings
object

Registration settings.

agreementSettings
object

Agreement settings.

string

Predefined Drawer (sidedrawer) Owner.

Response

Updated 7 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago