Get Brand Profile

GET

/api/v1/workspaces/{workspace_id}/email_design_systems/{emailDesignSystemId}/brand_profiles/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems/1/brand_profiles/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems/1/brand_profiles/1 \
  --header 'Authorization: Bearer <token>'

Retrieves a brand profile.

Authorizations

OAuth2
email_design_systems:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

emailDesignSystemId

required

integer

Email Design System ID

required

integer

Brand Profile ID

Responses

200

Successful

application/json

object

required

integer

name

required

string

component_overrides

required

Array<object>

object

component_name

required

string

hidden

required

When a component is hidden, it is not available for selection within the email editor.

boolean

field_overrides

required

Overrides for individual field defaults when this brand profile is active.

Array<object>

object

liquid_variable

required

string

default_value

One of:

string

hidden_in_editor

boolean

hidden_from_ai

boolean

label

string

design_tokens

required

object

key

additional properties

any

created_at

required

string format: date-time

updated_at

required

string format: date-time

email_design_system_id

required

integer

Example

{
  "id": 1,
  "name": "My Brand",
  "component_overrides": [
    {
      "component_name": "Headline",
      "hidden": false,
      "field_overrides": [
        {
          "liquid_variable": "headline",
          "default_value": "Hello, world!",
          "hidden_in_editor": false,
          "hidden_from_ai": false,
          "label": "Headline"
        }
      ]
    }
  ],
  "design_tokens": {
    "primary_button_color": "#007bff",
    "secondary_button_color": "#6c757d"
  },
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "email_design_system_id": 1
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}