Update branding

put

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

Updates branding by the identifier (brandId).

Path Params

brandId

string

required

tenantId

string

required

Tenant identifier.

Body Params

brandName

string

required

Brand name.

multiLanguage

boolean

Multi-language branding.

hideDefaultRecordTypes

boolean

Hide default Hangers (recordType).

hideRecords

boolean

Hide Folders (record).

hideCollaborators

boolean

Hide Collaborators.

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.

metadata

object

Metadata (key-value pairs).

authFlows

object

Auth flows.

universalRecordTypes

object

required

Universal Folder (record) types.

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.

predefinedSdOwner

string

Predefined Drawer (sidedrawer) Owner.

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 branding.