Skip to main content
POST
/
v0
/
brands
Create brand
curl --request POST \
  --url https://api.tryarchitect.com/v0/brands \
  --header 'Content-Type: application/json' \
  --data '{
  "companyHomePage": "<string>",
  "name": "Acme Corporation",
  "preferredAppearance": "system",
  "themeDark": {
    "borderColor": "<string>",
    "buttonBackgroundColor": "<string>",
    "buttonTextColor": "<string>",
    "favicon": {
      "type": "<string>",
      "url": "<string>"
    },
    "logo": {
      "type": "<string>",
      "url": "<string>"
    },
    "logoIcon": {
      "type": "<string>",
      "url": "<string>"
    },
    "mutedTextColor": "<string>",
    "pageBackgroundColor": "<string>",
    "pageForegroundColor": "<string>",
    "secondaryAccentColor": "<string>",
    "sectionCardHighlightColor": "<string>"
  },
  "themeLight": {
    "borderColor": "<string>",
    "buttonBackgroundColor": "<string>",
    "buttonTextColor": "<string>",
    "favicon": {
      "type": "<string>",
      "url": "<string>"
    },
    "logo": {
      "type": "<string>",
      "url": "<string>"
    },
    "logoIcon": {
      "type": "<string>",
      "url": "<string>"
    },
    "mutedTextColor": "<string>",
    "pageBackgroundColor": "<string>",
    "pageForegroundColor": "<string>",
    "secondaryAccentColor": "<string>",
    "sectionCardHighlightColor": "<string>"
  }
}'
{
  "brandId": "brand_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "companyHomePage": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "preferredAppearance": "system",
  "tenantId": "<string>",
  "themeDark": {
    "borderColor": "<string>",
    "buttonBackgroundColor": "<string>",
    "buttonTextColor": "<string>",
    "faviconFileId": "<string>",
    "faviconUrl": "<string>",
    "logoFileId": "<string>",
    "logoIconFileId": "<string>",
    "logoIconUrl": "<string>",
    "logoUrl": "<string>",
    "mutedTextColor": "<string>",
    "pageBackgroundColor": "<string>",
    "pageForegroundColor": "<string>",
    "secondaryAccentColor": "<string>",
    "sectionCardHighlightColor": "<string>"
  },
  "themeLight": {
    "borderColor": "<string>",
    "buttonBackgroundColor": "<string>",
    "buttonTextColor": "<string>",
    "faviconFileId": "<string>",
    "faviconUrl": "<string>",
    "logoFileId": "<string>",
    "logoIconFileId": "<string>",
    "logoIconUrl": "<string>",
    "logoUrl": "<string>",
    "mutedTextColor": "<string>",
    "pageBackgroundColor": "<string>",
    "pageForegroundColor": "<string>",
    "secondaryAccentColor": "<string>",
    "sectionCardHighlightColor": "<string>"
  },
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
name
string
required
Minimum length: 1
Examples:

"Acme Corporation"

"My Brand"

preferredAppearance
enum<string>
required
Available options:
system,
light,
dark
Examples:

"system"

themeDark
object
required
themeLight
object
required
companyHomePage
string<uri>

URL to open when action is triggered

Response

201 - application/json

Brand created successfully

brandId
string
required
Examples:

"brand_01j5k9m7n8p9q2r3s4t5v6w7x8"

createdAt
string<date-time>
required
name
string
required
preferredAppearance
enum<string>
required
Available options:
system,
light,
dark
tenantId
string
required
themeDark
object
required
themeLight
object
required
updatedAt
string<date-time>
required
companyHomePage
string<uri>

URL to open when action is triggered