Create Page Branding

post

https://{application_vanity_domain}/api/v1/page-brandings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

upsert

boolean

Defaults to false

Boolean indicating if the operation should be treated as an upsert

Body Params

Page Branding JSON object

Page Branding

string

ownerType

string

enum

required

length between 1 and 30

[Required on Create and Upsert] The type of the owner of the resource.

Allowed:

ownerId

string

required

length between 1 and 26

[Required on Create and Upsert] The ID of the owner of the resource.

pageBackgroundType

string

enum

length between 1 and 30

[Required on Create] The type of page background to render for a specific page branding.

Allowed:

pageBackgroundColor

string

length between 7 and 7

[Required on Create] The page background color to render, if applicable.

pageBackgroundImageUrl

uri

length between 1 and 2000

[Required if pageBackgroundType is IMAGE] The URL location of the page background image to render, if applicable.

panelBackgroundColor

string

length between 7 and 7

[Required on Create] The form panel background color to render.

panelTextColor

string

length between 7 and 7

[Required on Create] The panel text color to render.

panelBorderRadiusPixels

integer

0 to 64

[Required on Create] The border radius, in pixels, of the panel.

panelBorderColor

string

length between 7 and 7

[Required on Create] The panel text color to render.

panelBoxShadowEnabled

boolean

[Required on Create] Flag indicating whether a box shadow effect will be shown around the panel.

primaryButtonBackgroundColor

string

length between 7 and 7

[Required on Create] The primary button background color to render.

primaryButtonTextColor

string

length between 7 and 7

[Required on Create] The primary button text color to render.

primaryButtonBorderRadiusPixels

integer

0 to 32

[Required on Create] The border radius, in pixels, of the primary button.

primaryButtonBorderColor

string

length between 7 and 7

[Required on Create] The primary button border color to render.

primaryButtonFocusColor

string

length between 7 and 7

[Required on Create] The primary button focus color to render.

secondaryButtonBackgroundColor

string

length between 7 and 7

[Required on Create] The secondary button background color to render.

secondaryButtonTextColor

string

length between 7 and 7

[Required on Create] The secondary button text color to render.

secondaryButtonBorderRadiusPixels

integer

0 to 32

[Required on Create] The border radius, in pixels, of the secondary button.

secondaryButtonBorderColor

string

length between 7 and 7

[Required on Create] The secondary button border color to render.

secondaryButtonFocusColor

string

length between 7 and 7

[Required on Create] The secondary button focus color to render.

inputBackgroundColor

string

length between 7 and 7

[Required on Create] The input background color to render.

inputTextColor

string

length between 7 and 7

[Required on Create] The input text color to render.

inputBorderRadiusPixels

integer

0 to 32

[Required on Create] The border radius, in pixels, of the input.

inputBorderColor

string

length between 7 and 7

[Required on Create] The input border color to render.

inputFocusColor

string

length between 7 and 7

[Required on Create] The input focus color to render.

inputIconColor

string

length between 7 and 7

[Required on Create] The input icon color to render.

inputIconButtonHoverColor

string

length between 7 and 7

[Required on Create] The input icon button hover color to render.

successColor

string

length between 7 and 7

[Required on Create] The type of success color to render for form input state and snackbar notifications.

errorColor

string

length between 7 and 7

[Required on Create] The type of error color to render for form input state, form errors, and snackbar notifications.

linkColor

string

length between 7 and 7

[Required on Create] The type of link color to render.

linkHoverColor

string

length between 7 and 7

The type of link color to render when a user hovers over it (defaults to linkColor).

linkUnderlineAppearance

string

enum

length between 1 and 30

Defaults to ON_HOVER_ONLY

Enum representing when to render the underline style beneath links for a specific page branding.

Allowed:

logoUrl

uri

length between 1 and 2000

The URL location of the onboard logo to render.

logoHeightPixels

integer

16 to 160

Defaults to 56

The height, in pixels, of the logo image.

faviconUrl

uri

length between 1 and 2000

The URL location of the onboard favicon to render.

websiteUrl

uri

length between 1 and 2000

The URL to the application's main website

termsOfServiceUrl

uri

length between 1 and 2000

The URL to the application's terms of service page

privacyPolicyUrl

uri

length between 1 and 2000

The URL to the application's privacy policy page

supportUrl

uri

length between 1 and 2000

The URL to the application's support page.

supportEmail

string

length between 1 and 200

The application's support email.

metadata

string

applicationLoginPageBranding

object

Application Login Page Branding. For tenant owned page brandings this value must be undefined.

applicationSignupPageBranding

object

Application Signup Page Branding. For tenant owned page brandings this value must be undefined.

tenantLoginPageBranding

object

Tenant Login Page Branding

tenantSignupPageBranding

object

Tenant Signup Page Branding

Responses

200OK

201Created

400Bad Request

401Unauthorized

403Forbidden

405Method Not Allowed

406Not Acceptable

409Conflict

415Unsupported Media Type

500Internal Server Error

503Service Unavailable