Create branding flavour

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/branding/brand-id/{brandId}/flavours

Creates a branding flavour.

Path Params

brandId

string

required

tenantId

string

required

Tenant identifier.

Body Params

locale

string

enum

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

Allowed:

flavorName

string

Flavour name.

darkMode

boolean

Dark mode.

bypassSDCreation

boolean

Allow bypassing of Drawer creation.

primaryLogoExpanded

object

Primary logo expanded image URL.

primaryLogoContracted

object

Primary logo contracted image URL.

secondaryLogo

object

Secondary logo image URL.

primaryIsoLogo

object

Primary ISO logo image URL.

secondaryIsoLogo

object

Secondary ISO logo image URL.

topBanner

object

Top Banner Image URL.

emailHeaderBanner

object

Email header banner image URL.

footerMessage

string

Footer message.

styleSheet

object

StyleSheet details.

vCard

object

vCard Detail.

appSections

object

App sections.

socialLogin

boolean

Social login on Universal Login screen.

socialIdps

array of strings

Social Identity Providers.

socialIdps

idpRedirect

string

Identity Provider Redirect URL.

webAppRoot

string

Web app root.

forceSDCreation

boolean

Force Drawer (sidedrawer) creation.

hideChatBubble

boolean

Hide chat bubble.

hideTeamMembers

boolean

Hide Team Members screen.

hideSummary

boolean

Hide Summary.

hideRequests

boolean

Hide Requests.

simplifiedRecordView

boolean

Simplified Folder (record) view.

hideReminders

boolean

Hide Reminders.

noSDAvailableMessage

string

No SD available message.

skipSponsorEditorAssignment

boolean

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

exclusiveBrandRecordTypesOnly

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.

universalRecordTypes

object

required

Universal Folder (record) types.

hideEmptyTiles

boolean

Hide empty Tiles.

hideHeaderUploadButton

boolean

Hide upload button.

hideCollaborators

boolean

Hide Collaborators.

hideRecords

boolean

Hide Folders (record).

hideCreateRecordButton

boolean

Hide create Folder (record) button.

hideRecordNameEditButton

boolean

Hide Folder (record) name button.

hideRecordContextMenuButton

boolean

Hide Folder (record) context menu button.

hideRecordEditButton

boolean

Hide Folder (record) edit button.

hideFileDownloadButton

boolean

Hide file name edit button.

hideAllFilesActionButton

boolean

Hide all files action button.

hideFileContextMenuButton

boolean

Hide file context menu button.

hideFileViewerTools

boolean

Hide file viewer tools.

hideFileViewerActionButtons

boolean

Hide file viewer action buttons.

hideRecordUploadFileButton

boolean

Hide Folder (record) upload file button.

hideSDCreationButton

boolean

Hide Drawer (sidedrawer) Creation Button.

allowSubRecords

boolean

Disable sub-records.

notifyPhoneChange

boolean

Defaults to false

Phone changes notifications.

predefinedSdOwner

string

Predefined Drawer (sidedrawer) Owner.

agreementSettings

object

Agreement settings.

registrationSettings

object

Registration settings.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The list of brandings.