brand
Open an operation to see its authentication, its parameters and the fields of its request and response.
11 operations
GET/v1/brand
Brand profiles, their workspaces and what the plan allows (owner, admin).
/v1/brandAuthentication: Dashboard session
Response 200
| Name | Type | Description |
|---|---|---|
organizationrequired | object | |
organization.namerequired | string | |
organization.typerequired | enum | Values direct | agency |
organization.planrequired | enum | Values none | open_source | indie | startup | growth | managed | agency | enterprise |
profilesrequired | array of object | |
profiles[].idrequired | string | |
profiles[].org_idrequired | string | |
profiles[].namerequired | string | |
profiles[].is_defaultrequired | boolean | |
profiles[].logo_urlrequired | string (uri) | |
profiles[].primary_colorrequired | string | |
profiles[].primary_color_effectiverequired | string | |
profiles[].color_adjustedrequired | boolean | |
profiles[].font_familyrequired | string | |
profiles[].localerequired | enum | Values en | it |
profiles[].sender_namerequired | string | |
profiles[].sender_emailrequired | string (email) | |
profiles[].custom_domainrequired | string | |
profiles[].status_domainrequired | string | |
profiles[].inbound_domainrequired | string | |
profiles[].show_badgerequired | boolean | |
profiles[].widget_textsrequired | object | |
profiles[].widget_texts.button | string | |
profiles[].widget_texts.title | string | |
profiles[].widget_texts.message_label | string | |
profiles[].widget_texts.message_placeholder | string | |
profiles[].widget_texts.email_label | string | |
profiles[].widget_texts.technical_consent | string | |
profiles[].widget_texts.screenshot_button | string | |
profiles[].widget_texts.screenshot_consent | string | |
profiles[].widget_texts.submit | string | |
profiles[].widget_texts.confirmation | string | |
profiles[].widget_texts.follow_link | string | |
profiles[].widget_texts.error | string | |
profiles[].website_urlrequired | string (uri) | |
profiles[].domain_dns_recordsrequired | array of object | |
profiles[].domain_dns_records[].purposerequired | enum | Values sending | receiving | status_page |
profiles[].domain_dns_records[].record | string | |
profiles[].domain_dns_records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
profiles[].domain_dns_records[].namerequired | string | |
profiles[].domain_dns_records[].valuerequired | string | |
profiles[].domain_dns_records[].priority | integer | |
profiles[].domain_dns_records[].ttl | string | integer | |
profiles[].domain_dns_records[].status | enum | Values not_started | pending | verified | failed | temporary_failure |
profiles[].domain_verified_atrequired | string (date-time) | |
profiles[].inbound_verified_atrequired | string (date-time) | |
profiles[].status_domain_verified_atrequired | string (date-time) | |
profiles[].created_atrequired | string (date-time) | |
profiles[].updated_atrequired | string (date-time) | |
profiles[].themerequired | enum | Values light | dark |
profiles[].logorequired | object | |
profiles[].logo.sourcerequired | enum | Values upload | url |
profiles[].logo.urlrequired | string (uri) | |
profiles[].logo.content_typerequired | enum | Values image/png | image/jpeg | image/webp |
profiles[].logo.widthrequired | integer | |
profiles[].logo.heightrequired | integer | |
profiles[].logo.size_bytesrequired | integer | |
profiles[].logo.uploaded_atrequired | string (date-time) | |
profiles[].logo.preview_urlrequired | string (uri) | |
profiles[].status_domain_staterequired | object | |
profiles[].status_domain_state.domainrequired | string | |
profiles[].status_domain_state.verifiedrequired | boolean | |
profiles[].status_domain_state.verified_atrequired | string (date-time) | |
profiles[].status_domain_state.cnamerequired | object | |
profiles[].status_domain_state.cname.typerequired | enum | Values CNAME | TXT |
profiles[].status_domain_state.cname.namerequired | string | |
profiles[].status_domain_state.cname.valuerequired | string | |
profiles[].status_domain_state.txtrequired | object | |
profiles[].status_domain_state.txt.typerequired | enum | Values CNAME | TXT |
profiles[].status_domain_state.txt.namerequired | string | |
profiles[].status_domain_state.txt.valuerequired | string | |
profiles[].status_domain_state.cname_okrequired | boolean | |
profiles[].status_domain_state.txt_okrequired | boolean | |
profiles[].status_domain_state.last_checked_atrequired | string (date-time) | |
profiles[].status_domain_state.last_errorrequired | enum | Values cname_missing | cname_mismatch | txt_missing | txt_mismatch | dns_error | domain_taken |
profiles[].status_domain_state.failing_sincerequired | string (date-time) | |
profiles[].email_dns_recordsrequired | array of object | |
profiles[].email_dns_records[].purposerequired | enum | Values sending | receiving | status_page |
profiles[].email_dns_records[].record | string | |
profiles[].email_dns_records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
POST/v1/brand/profiles
Creates a brand profile (owner, admin).
/v1/brand/profilesAuthentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
namerequired | string | |
is_default | boolean | |
primary_color | string | |
sender_name | string | |
sender_email | string | |
font_family | enum | Values Albert Sans | Archivo | Barlow | Bricolage Grotesque | Cabin | Crimson Pro | DM Sans | Figtree | Fira Sans | Fraunces | Hanken Grotesk | IBM Plex Sans | Instrument Sans | Inter | Josefin Sans | Karla | Lexend | Libre Franklin | Lora | Manrope | Montserrat | Mulish | Noto Sans | Noto Serif | Nunito | Nunito Sans | Onest | Open Sans | Outfit | Playfair Display | Plus Jakarta Sans | Poppins | Public Sans | Quicksand | Raleway | Red Hat Display | Red Hat Text | Roboto | Roboto Slab | Rubik | Schibsted Grotesk | Sora | Source Sans 3 | Source Serif 4 | Space Grotesk | Ubuntu | Urbanist | Work Sans |
locale | enum | Values en | it |
website_url | string | |
logo_url | string | |
show_badge | boolean | |
widget_texts | object | |
widget_texts.button | string | |
widget_texts.title | string | |
widget_texts.message_label | string | |
widget_texts.message_placeholder | string | |
widget_texts.email_label | string | |
widget_texts.technical_consent | string | |
widget_texts.screenshot_button | string | |
widget_texts.screenshot_consent | string | |
widget_texts.submit | string | |
widget_texts.confirmation | string | |
widget_texts.follow_link | string | |
widget_texts.error | string | |
theme | enum | Values light | dark |
Response 201
| Name | Type | Description |
|---|---|---|
idrequired | string | |
org_idrequired | string | |
namerequired | string | |
is_defaultrequired | boolean | |
logo_urlrequired | string (uri) | |
primary_colorrequired | string | |
primary_color_effectiverequired | string | |
color_adjustedrequired | boolean | |
font_familyrequired | string | |
localerequired | enum | Values en | it |
sender_namerequired | string | |
sender_emailrequired | string (email) | |
custom_domainrequired | string | |
status_domainrequired | string | |
inbound_domainrequired | string | |
show_badgerequired | boolean | |
widget_textsrequired | object | |
widget_texts.button | string | |
widget_texts.title | string | |
widget_texts.message_label | string | |
widget_texts.message_placeholder | string | |
widget_texts.email_label | string | |
widget_texts.technical_consent | string | |
widget_texts.screenshot_button | string | |
widget_texts.screenshot_consent | string | |
widget_texts.submit | string | |
widget_texts.confirmation | string | |
widget_texts.follow_link | string | |
widget_texts.error | string | |
website_urlrequired | string (uri) | |
domain_dns_recordsrequired | array of object | |
domain_dns_records[].purposerequired | enum | Values sending | receiving | status_page |
domain_dns_records[].record | string | |
domain_dns_records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
domain_dns_records[].namerequired | string | |
domain_dns_records[].valuerequired | string | |
domain_dns_records[].priority | integer | |
domain_dns_records[].ttl | string | integer | |
domain_dns_records[].status | enum | Values not_started | pending | verified | failed | temporary_failure |
domain_verified_atrequired | string (date-time) | |
inbound_verified_atrequired | string (date-time) | |
status_domain_verified_atrequired | string (date-time) | |
created_atrequired | string (date-time) | |
updated_atrequired | string (date-time) | |
themerequired | enum | Values light | dark |
logorequired | object | |
logo.sourcerequired | enum | Values upload | url |
logo.urlrequired | string (uri) | |
logo.content_typerequired | enum | Values image/png | image/jpeg | image/webp |
logo.widthrequired | integer | |
logo.heightrequired | integer | |
logo.size_bytesrequired | integer | |
logo.uploaded_atrequired | string (date-time) | |
logo.preview_urlrequired | string (uri) | |
status_domain_staterequired | object | |
status_domain_state.domainrequired | string | |
status_domain_state.verifiedrequired | boolean | |
status_domain_state.verified_atrequired | string (date-time) | |
status_domain_state.cnamerequired | object | |
status_domain_state.cname.typerequired | enum | Values CNAME | TXT |
status_domain_state.cname.namerequired | string | |
status_domain_state.cname.valuerequired | string | |
status_domain_state.txtrequired | object | |
status_domain_state.txt.typerequired | enum | Values CNAME | TXT |
status_domain_state.txt.namerequired | string | |
status_domain_state.txt.valuerequired | string | |
status_domain_state.cname_okrequired | boolean | |
status_domain_state.txt_okrequired | boolean | |
status_domain_state.last_checked_atrequired | string (date-time) | |
status_domain_state.last_errorrequired | enum | Values cname_missing | cname_mismatch | txt_missing | txt_mismatch | dns_error | domain_taken |
status_domain_state.failing_sincerequired | string (date-time) | |
email_dns_recordsrequired | array of object | |
email_dns_records[].purposerequired | enum | Values sending | receiving | status_page |
email_dns_records[].record | string | |
email_dns_records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
email_dns_records[].namerequired | string | |
email_dns_records[].valuerequired | string | |
email_dns_records[].priority | integer | |
email_dns_records[].ttl | string | integer | |
email_dns_records[].status | enum | Values not_started | pending | verified | failed | temporary_failure |
GET/v1/brand/profiles/{id}
One brand profile.
/v1/brand/profiles/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as POST /v1/brand/profiles.
PATCH/v1/brand/profiles/{id}
Changes a brand profile; the color is darkened to WCAG AA when needed.
/v1/brand/profiles/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
name | string | |
is_default | boolean | |
primary_color | string | |
sender_name | string | |
sender_email | string | |
font_family | enum | Values Albert Sans | Archivo | Barlow | Bricolage Grotesque | Cabin | Crimson Pro | DM Sans | Figtree | Fira Sans | Fraunces | Hanken Grotesk | IBM Plex Sans | Instrument Sans | Inter | Josefin Sans | Karla | Lexend | Libre Franklin | Lora | Manrope | Montserrat | Mulish | Noto Sans | Noto Serif | Nunito | Nunito Sans | Onest | Open Sans | Outfit | Playfair Display | Plus Jakarta Sans | Poppins | Public Sans | Quicksand | Raleway | Red Hat Display | Red Hat Text | Roboto | Roboto Slab | Rubik | Schibsted Grotesk | Sora | Source Sans 3 | Source Serif 4 | Space Grotesk | Ubuntu | Urbanist | Work Sans |
locale | enum | Values en | it |
website_url | string | |
logo_url | string | |
show_badge | boolean | |
widget_texts | object | |
widget_texts.button | string | |
widget_texts.title | string | |
widget_texts.message_label | string | |
widget_texts.message_placeholder | string | |
widget_texts.email_label | string | |
widget_texts.technical_consent | string | |
widget_texts.screenshot_button | string | |
widget_texts.screenshot_consent | string | |
widget_texts.submit | string | |
widget_texts.confirmation | string | |
widget_texts.follow_link | string | |
widget_texts.error | string | |
theme | enum | Values light | dark |
Response 200
The same fields as POST /v1/brand/profiles.
DELETE/v1/brand/profiles/{id}
Deletes a brand profile; its workspaces fall back to the default.
/v1/brand/profiles/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
okrequired | true |
PUT/v1/brand/profiles/{id}/logo
Uploads the logo (PNG, JPEG or WebP, at most 512 KiB).
/v1/brand/profiles/{id}/logoAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
content_typerequired | enum | Values image/png | image/jpeg | image/webp |
data_base64required | string |
Response 200
The same fields as POST /v1/brand/profiles.
DELETE/v1/brand/profiles/{id}/logo
Removes the logo: surfaces show the name as text.
/v1/brand/profiles/{id}/logoAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as POST /v1/brand/profiles.
PUT/v1/brand/profiles/{id}/status-domain
Sets the custom status domain and returns the DNS records to publish.
/v1/brand/profiles/{id}/status-domainAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
domainrequired | string |
Response 200
The same fields as POST /v1/brand/profiles.
DELETE/v1/brand/profiles/{id}/status-domain
Removes the custom status domain: status pages go back to the default host.
/v1/brand/profiles/{id}/status-domainAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as POST /v1/brand/profiles.
POST/v1/brand/profiles/{id}/status-domain/verify
Checks the DNS records of the status domain now.
/v1/brand/profiles/{id}/status-domain/verifyAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
profilerequired | object | |
profile.idrequired | string | |
profile.org_idrequired | string | |
profile.namerequired | string | |
profile.is_defaultrequired | boolean | |
profile.logo_urlrequired | string (uri) | |
profile.primary_colorrequired | string | |
profile.primary_color_effectiverequired | string | |
profile.color_adjustedrequired | boolean | |
profile.font_familyrequired | string | |
profile.localerequired | enum | Values en | it |
profile.sender_namerequired | string | |
profile.sender_emailrequired | string (email) | |
profile.custom_domainrequired | string | |
profile.status_domainrequired | string | |
profile.inbound_domainrequired | string | |
profile.show_badgerequired | boolean | |
profile.widget_textsrequired | object | |
profile.widget_texts.button | string | |
profile.widget_texts.title | string | |
profile.widget_texts.message_label | string | |
profile.widget_texts.message_placeholder | string | |
profile.widget_texts.email_label | string | |
profile.widget_texts.technical_consent | string | |
profile.widget_texts.screenshot_button | string | |
profile.widget_texts.screenshot_consent | string | |
profile.widget_texts.submit | string | |
profile.widget_texts.confirmation | string | |
profile.widget_texts.follow_link | string | |
profile.widget_texts.error | string | |
profile.website_urlrequired | string (uri) | |
profile.domain_dns_recordsrequired | array of object | |
profile.domain_dns_records[].purposerequired | enum | Values sending | receiving | status_page |
profile.domain_dns_records[].record | string | |
profile.domain_dns_records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
profile.domain_dns_records[].namerequired | string | |
profile.domain_dns_records[].valuerequired | string | |
profile.domain_dns_records[].priority | integer | |
profile.domain_dns_records[].ttl | string | integer | |
profile.domain_dns_records[].status | enum | Values not_started | pending | verified | failed | temporary_failure |
profile.domain_verified_atrequired | string (date-time) | |
profile.inbound_verified_atrequired | string (date-time) | |
profile.status_domain_verified_atrequired | string (date-time) | |
profile.created_atrequired | string (date-time) | |
profile.updated_atrequired | string (date-time) | |
profile.themerequired | enum | Values light | dark |
profile.logorequired | object | |
profile.logo.sourcerequired | enum | Values upload | url |
profile.logo.urlrequired | string (uri) | |
profile.logo.content_typerequired | enum | Values image/png | image/jpeg | image/webp |
profile.logo.widthrequired | integer | |
profile.logo.heightrequired | integer | |
profile.logo.size_bytesrequired | integer | |
profile.logo.uploaded_atrequired | string (date-time) | |
profile.logo.preview_urlrequired | string (uri) | |
profile.status_domain_staterequired | object | |
profile.status_domain_state.domainrequired | string | |
profile.status_domain_state.verifiedrequired | boolean | |
profile.status_domain_state.verified_atrequired | string (date-time) | |
profile.status_domain_state.cnamerequired | object | |
profile.status_domain_state.cname.typerequired | enum | Values CNAME | TXT |
profile.status_domain_state.cname.namerequired | string | |
profile.status_domain_state.cname.valuerequired | string | |
profile.status_domain_state.txtrequired | object | |
profile.status_domain_state.txt.typerequired | enum | Values CNAME | TXT |
profile.status_domain_state.txt.namerequired | string | |
profile.status_domain_state.txt.valuerequired | string | |
profile.status_domain_state.cname_okrequired | boolean | |
profile.status_domain_state.txt_okrequired | boolean | |
profile.status_domain_state.last_checked_atrequired | string (date-time) | |
profile.status_domain_state.last_errorrequired | enum | Values cname_missing | cname_mismatch | txt_missing | txt_mismatch | dns_error | domain_taken |
profile.status_domain_state.failing_sincerequired | string (date-time) | |
profile.email_dns_recordsrequired | array of object | |
profile.email_dns_records[].purposerequired | enum | Values sending | receiving | status_page |
profile.email_dns_records[].record | string | |
profile.email_dns_records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
profile.email_dns_records[].namerequired | string | |
profile.email_dns_records[].valuerequired | string | |
profile.email_dns_records[].priority | integer | |
profile.email_dns_records[].ttl | string | integer |
PUT/v1/brand/workspaces/{id}
Chooses the brand profile of a workspace (null: the default).
/v1/brand/workspaces/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
brand_profile_idrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
idrequired | string | |
namerequired | string | |
client_namerequired | string | |
slugrequired | string | |
brand_profile_idrequired | string | |
effective_profile_idrequired | string | |
show_badgerequired | boolean | |
status_base_urlrequired | string (uri) | |
changelog_enabledrequired | boolean | |
white_label_missingrequired | array of enum |