Brand kits

List brand kits

GET/api/v1/brand-kits

GET /brand-kits
curl -X GET 'https://www.unitpost.com/api/v1/brand-kits' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "brand_kit",
      "id": "id_123",
      "name": "Example",
      "is_default": false,
      "website_url": "https://example.com",
      "description": "string",
      "tone": "NEUTRAL",
      "voice_notes": "string",
      "industry": "string",
      "core_pages": [
        {
          "url": "https://example.com",
          "title": "string"
        }
      ],
      "extracted": {
        "colors": [
          {
            "hex": "string",
            "label": "string"
          }
        ],
        "logo_urls": [
          "string"
        ],
        "background_urls": [
          "string"
        ],
        "fonts": [
          "string"
        ]
      },
      "graphics": [
        {
          "library_image_id": "library_image_123",
          "image_id": "image_123",
          "path": "string",
          "role": "logo",
          "label": "string"
        }
      ],
      "source": "string",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "default_id": "default_123"
}

Retrieve every Brand Kit profile in the workspace (up to five named profiles). Each profile holds tone, about, voice notes, labeled colors, pinned logo/background library images, and core pages — the primary brand context for on-brand template authoring. Pass ?name= to filter to one profile by display name (case-insensitive). The response includes default_id for the Default profile. Fetch one by id with Retrieve a brand kit. Create, edit and import profiles with branding:write. Requires the templates:read capability.

Parameters1 field
FieldTypeDescription
namestring · queryFilter to a single profile by display name (case-insensitive).
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
is_defaultrequiredboolean—
website_urlrequiredstring | null—
descriptionrequiredstring | null—
tonerequiredenum | null—
voice_notesrequiredstring | null—
industryrequiredstring | null—
core_pagesrequiredobject[]—
extractedrequiredobject—
graphicsrequiredobject[]—
sourcerequiredstring | null—
updated_atrequiredstring | null—
200401403

Create a brand kit

POST/api/v1/brand-kits

POST /brand-kits
curl -X POST 'https://www.unitpost.com/api/v1/brand-kits' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 201
{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "image_id": "image_123",
      "path": "string",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Create an empty profile (name, unique in the workspace). The first profile, or one with make_default, becomes the default. At most five profiles (403 limit_reached). Fill it with Update a brand kit or an import. Requires the branding:write capability.

Request body2 fields
FieldTypeDescription
namerequiredstringUnique in the workspace.
make_defaultbooleanMake it the default profile (the first profile always is).
Response · 201 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
is_defaultrequiredboolean—
website_urlrequiredstring | null—
descriptionrequiredstring | null—
tonerequiredenum | null—
voice_notesrequiredstring | null—
industryrequiredstring | null—
core_pagesrequiredobject[]—
extractedrequiredobject—
graphicsrequiredobject[]—
sourcerequiredstring | null—
updated_atrequiredstring | null—
201400401403409422429

Retrieve a brand kit

GET/api/v1/brand-kits/{id}

GET /brand-kits/{id}
curl -X GET 'https://www.unitpost.com/api/v1/brand-kits/bk_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "image_id": "image_123",
      "path": "string",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve one Brand Kit profile by id (bk_…), including voice, labeled colors, pinned graphics (library_image_id for /img/{id} in design TSX), and core pages. List every profile with List brand kits. Requires the templates:read capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
is_defaultrequiredboolean—
website_urlrequiredstring | null—
descriptionrequiredstring | null—
tonerequiredenum | null—
voice_notesrequiredstring | null—
industryrequiredstring | null—
core_pagesrequiredobject[]—
extractedrequiredobject—
graphicsrequiredobject[]—
sourcerequiredstring | null—
updated_atrequiredstring | null—
200401403404

Update a brand kit

PATCH/api/v1/brand-kits/{id}

PATCH /brand-kits/{id}
curl -X PATCH 'https://www.unitpost.com/api/v1/brand-kits/bk_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 200
{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "image_id": "image_123",
      "path": "string",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Edit a profile: voice, tone, description, industry, website, core pages, the palette and logo candidates (extracted), and the pinned graphics (library images, img_…). Only the fields sent change; a list replaces the list; null or "" clears a text field. sync_visual on the default profile also sets the email branding's accent from these colors. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Request body10 fields
FieldTypeDescription
namestring—
website_urlstring | nullAn https URL; `null` or `""` clears it.
descriptionstring | nullWhat the brand does.
toneenum | null—
voice_notesstring | nullDos and don'ts for writing in this voice.
industrystring | nullThe brand's industry.
core_pagesobject[]Replaces the list.
extractedobjectThe palette, logo and background candidates, fonts. Replaces the set.
graphicsobject[]The pinned library images (`img_…`). Replaces the list.
sync_visualbooleanOn the default profile, also set the email branding's accent from these colors (no change on another profile, or without a usable accent).
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
is_defaultrequiredboolean—
website_urlrequiredstring | null—
descriptionrequiredstring | null—
tonerequiredenum | null—
voice_notesrequiredstring | null—
industryrequiredstring | null—
core_pagesrequiredobject[]—
extractedrequiredobject—
graphicsrequiredobject[]—
sourcerequiredstring | null—
updated_atrequiredstring | null—
200400401403404409422429

Delete a brand kit

DELETE/api/v1/brand-kits/{id}

DELETE /brand-kits/{id}
curl -X DELETE 'https://www.unitpost.com/api/v1/brand-kits/bk_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Delete a profile. When it was the default, the oldest remaining profile becomes the default. The last profile can't be deleted (409): reset it instead. Its pinned images stay in the library. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
204401403404409422429

Reset a brand kit

POST/api/v1/brand-kits/{id}/reset

POST /brand-kits/{id}/reset
curl -X POST 'https://www.unitpost.com/api/v1/brand-kits/bk_123/reset' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "image_id": "image_123",
      "path": "string",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Clear a profile's content (voice, colors, graphics, pages) and keep its name and whether it's the default. Takes no body. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
is_defaultrequiredboolean—
website_urlrequiredstring | null—
descriptionrequiredstring | null—
tonerequiredenum | null—
voice_notesrequiredstring | null—
industryrequiredstring | null—
core_pagesrequiredobject[]—
extractedrequiredobject—
graphicsrequiredobject[]—
sourcerequiredstring | null—
updated_atrequiredstring | null—
200400401403404422429

Make a brand kit the default

POST/api/v1/brand-kits/{id}/set-default

POST /brand-kits/{id}/set-default
curl -X POST 'https://www.unitpost.com/api/v1/brand-kits/bk_123/set-default' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "image_id": "image_123",
      "path": "string",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Make a profile the default: the one agents write with unless told otherwise. Takes no body. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
is_defaultrequiredboolean—
website_urlrequiredstring | null—
descriptionrequiredstring | null—
tonerequiredenum | null—
voice_notesrequiredstring | null—
industryrequiredstring | null—
core_pagesrequiredobject[]—
extractedrequiredobject—
graphicsrequiredobject[]—
sourcerequiredstring | null—
updated_atrequiredstring | null—
200400401403404409422429

Add a graphic to a brand kit

POST/api/v1/brand-kits/{id}/graphics

POST /brand-kits/{id}/graphics
curl -X POST 'https://www.unitpost.com/api/v1/brand-kits/bk_123/graphics' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 201
{
  "object": "brand_kit_graphic",
  "brand_kit": {
    "object": "brand_kit",
    "id": "id_123",
    "name": "Example",
    "is_default": false,
    "website_url": "https://example.com",
    "description": "string",
    "tone": "NEUTRAL",
    "voice_notes": "string",
    "industry": "string",
    "core_pages": [
      {
        "url": "https://example.com",
        "title": "string"
      }
    ],
    "extracted": {
      "colors": [
        {
          "hex": "string",
          "label": "string"
        }
      ],
      "logo_urls": [
        "string"
      ],
      "background_urls": [
        "string"
      ],
      "fonts": [
        "string"
      ]
    },
    "graphics": [
      {
        "library_image_id": "library_image_123",
        "image_id": "image_123",
        "path": "string",
        "role": "logo",
        "label": "string"
      }
    ],
    "source": "string",
    "updated_at": "2026-01-01T00:00:00.000Z"
  },
  "image": {
    "object": "library_image",
    "id": "id_123",
    "path": "string",
    "url": "https://example.com",
    "filename": "string",
    "content_type": "string",
    "size": 1,
    "width": 0,
    "height": 0,
    "alt": "string",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Add a graphic from a public https image url (fetched once, no redirects): it goes into the image library, counted against its storage, and is pinned with its role (default logo). To pin an image already in the library, Update a brand kit with graphics. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Request body3 fields
FieldTypeDescription
urlrequiredstringA public https PNG, JPEG, GIF or WebP (fetched once, no redirects; up to 5 MB).
roleenumlogo | logo_light | logo_dark | mark | background | otherDefault `logo`.
labelstring—
Response · 201 fields3 fields
FieldTypeDescription
objectrequiredstring—
brand_kitrequiredobject—
imagerequiredobject—
201400401403404422429503

Import a brand kit

POST/api/v1/brand-kits/imports

POST /brand-kits/imports
curl -X POST 'https://www.unitpost.com/api/v1/brand-kits/imports' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 202
{
  "object": "brand_import",
  "id": "id_123",
  "status": "pending",
  "review": false,
  "source": {
    "kind": "url",
    "url": "https://example.com"
  },
  "brand_kit_id": "brand_kit_123",
  "proposal": {
    "name": "Example",
    "website_url": "https://example.com",
    "description": "string",
    "tone": "NEUTRAL",
    "voice_notes": "string",
    "industry": "string",
    "core_pages": [
      {
        "url": "https://example.com",
        "title": "string"
      }
    ],
    "extracted": {
      "colors": [
        {
          "hex": "string",
          "label": "string"
        }
      ],
      "logo_urls": [
        "string"
      ],
      "background_urls": [
        "string"
      ],
      "fonts": [
        "string"
      ]
    },
    "memory_facts": [
      {
        "key": "string",
        "content": "string"
      }
    ]
  },
  "warnings": [
    "string"
  ],
  "error": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z"
}

Build a profile from a website (url, or a bare domain) or the brand's own words (text). It runs in the background, usually under a minute (202; follow it with Retrieve a brand kit import). By default the result is applied when it lands: to brand_kit_id, else the default profile, or a new one when the default already has content. With review: true it stops at a proposal (preview_ready) for Accept a brand kit import; one review import is open at a time, and a new one replaces it. Applying an import started here never adds a sending domain (add one with Add a domain). Requires the branding:write capability.

Request body6 fields
FieldTypeDescription
urlstringThe site to read: an https URL or a bare domain (`acme.com`).
textstringOr paste the brand's own words (an about page, a style guide).
website_urlstring | nullWith `text`: the brand's site, for the profile.
brand_kit_idstringThe profile to fill (`bk_…`). Default: the default profile, or a new one when it already has content.
reviewboolean`true` stops at the proposal for you to accept (POST …/accept); default `false` applies it when ready.
sync_visualbooleanAlso set the email branding's accent from the imported colors (the default profile only).
Response · 202 fields12 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
statusrequiredenumpending | running | preview_ready | completed | failed | cancelled`preview_ready`: the proposal waits for an accept (review imports) or is being applied (one-shot); with an `error` on a one-shot import, applying it failed: accept or cancel it.
reviewrequiredbooleanWhether it waits for an accept (false: applied when the crawl lands).
sourcerequiredobject—
brand_kit_idrequiredstring | nullThe profile it fills.
proposalrequiredobject | nullWhat the import found, once ready.
warningsrequiredstring[]—
errorrequiredstring | null—
created_atrequiredstring—
updated_atrequiredstring—
completed_atrequiredstring | null—
202400401403404422429

Retrieve a brand kit import

GET/api/v1/brand-kits/imports/{id}

GET /brand-kits/imports/{id}
curl -X GET 'https://www.unitpost.com/api/v1/brand-kits/imports/bki_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "brand_import",
  "id": "id_123",
  "status": "pending",
  "review": false,
  "source": {
    "kind": "url",
    "url": "https://example.com"
  },
  "brand_kit_id": "brand_kit_123",
  "proposal": {
    "name": "Example",
    "website_url": "https://example.com",
    "description": "string",
    "tone": "NEUTRAL",
    "voice_notes": "string",
    "industry": "string",
    "core_pages": [
      {
        "url": "https://example.com",
        "title": "string"
      }
    ],
    "extracted": {
      "colors": [
        {
          "hex": "string",
          "label": "string"
        }
      ],
      "logo_urls": [
        "string"
      ],
      "background_urls": [
        "string"
      ],
      "fonts": [
        "string"
      ]
    },
    "memory_facts": [
      {
        "key": "string",
        "content": "string"
      }
    ]
  },
  "warnings": [
    "string"
  ],
  "error": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z"
}

One import: its status, the proposal once it's ready, warnings and any error. Requires the templates:read capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields12 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
statusrequiredenumpending | running | preview_ready | completed | failed | cancelled`preview_ready`: the proposal waits for an accept (review imports) or is being applied (one-shot); with an `error` on a one-shot import, applying it failed: accept or cancel it.
reviewrequiredbooleanWhether it waits for an accept (false: applied when the crawl lands).
sourcerequiredobject—
brand_kit_idrequiredstring | nullThe profile it fills.
proposalrequiredobject | nullWhat the import found, once ready.
warningsrequiredstring[]—
errorrequiredstring | null—
created_atrequiredstring—
updated_atrequiredstring—
completed_atrequiredstring | null—
200401403404422

Accept a brand kit import

POST/api/v1/brand-kits/imports/{id}/accept

POST /brand-kits/imports/{id}/accept
curl -X POST 'https://www.unitpost.com/api/v1/brand-kits/imports/bki_123/accept' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 200
{
  "object": "brand_import",
  "id": "id_123",
  "status": "pending",
  "review": false,
  "source": {
    "kind": "url",
    "url": "https://example.com"
  },
  "brand_kit_id": "brand_kit_123",
  "proposal": {
    "name": "Example",
    "website_url": "https://example.com",
    "description": "string",
    "tone": "NEUTRAL",
    "voice_notes": "string",
    "industry": "string",
    "core_pages": [
      {
        "url": "https://example.com",
        "title": "string"
      }
    ],
    "extracted": {
      "colors": [
        {
          "hex": "string",
          "label": "string"
        }
      ],
      "logo_urls": [
        "string"
      ],
      "background_urls": [
        "string"
      ],
      "fonts": [
        "string"
      ]
    },
    "memory_facts": [
      {
        "key": "string",
        "content": "string"
      }
    ]
  },
  "warnings": [
    "string"
  ],
  "error": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "brand_kit": {
    "object": "brand_kit",
    "id": "id_123",
    "name": "Example",
    "is_default": false,
    "website_url": "https://example.com",
    "description": "string",
    "tone": "NEUTRAL",
    "voice_notes": "string",
    "industry": "string",
    "core_pages": [
      {
        "url": "https://example.com",
        "title": "string"
      }
    ],
    "extracted": {
      "colors": [
        {
          "hex": "string",
          "label": "string"
        }
      ],
      "logo_urls": [
        "string"
      ],
      "background_urls": [
        "string"
      ],
      "fonts": [
        "string"
      ]
    },
    "graphics": [
      {
        "library_image_id": "library_image_123",
        "image_id": "image_123",
        "path": "string",
        "role": "logo",
        "label": "string"
      }
    ],
    "source": "string",
    "updated_at": "2026-01-01T00:00:00.000Z"
  },
  "apply_warnings": [
    "string"
  ]
}

Apply a review import's proposal (preview_ready) to a profile: voice, colors and pages, and its logos and backgrounds brought into the image library and pinned. Without brand_kit_id it fills the profile the import named, else the default, or a new profile when the default has content; the profile takes the name the import found unless you send name. A one-shot import whose automatic apply failed (preview_ready with an error) can be accepted too. The site becomes a sending domain only when the key holds domains:write. To change fields, accept and then Update a brand kit. The body is optional. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Request body3 fields
FieldTypeDescription
brand_kit_idstringApply to this profile instead of the one the import named.
namestringThe profile's name (default: the one the import found).
sync_visualbooleanAlso set the email branding's accent from the imported colors (the default profile only).
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
statusrequiredenumpending | running | preview_ready | completed | failed | cancelled`preview_ready`: the proposal waits for an accept (review imports) or is being applied (one-shot); with an `error` on a one-shot import, applying it failed: accept or cancel it.
reviewrequiredbooleanWhether it waits for an accept (false: applied when the crawl lands).
sourcerequiredobject—
brand_kit_idrequiredstring | nullThe profile it fills.
proposalrequiredobject | nullWhat the import found, once ready.
warningsrequiredstring[]—
errorrequiredstring | null—
created_atrequiredstring—
updated_atrequiredstring—
completed_atrequiredstring | null—
brand_kitrequiredobjectThe profile as the accept left it.
apply_warningsrequiredstring[]What the accept couldn't bring in (a logo that wouldn't fetch, the graphics cap, a renamed profile).
200400401403404409422429

Cancel a brand kit import

POST/api/v1/brand-kits/imports/{id}/cancel

POST /brand-kits/imports/{id}/cancel
curl -X POST 'https://www.unitpost.com/api/v1/brand-kits/imports/bki_123/cancel' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "brand_import",
  "id": "id_123",
  "status": "pending",
  "review": false,
  "source": {
    "kind": "url",
    "url": "https://example.com"
  },
  "brand_kit_id": "brand_kit_123",
  "proposal": {
    "name": "Example",
    "website_url": "https://example.com",
    "description": "string",
    "tone": "NEUTRAL",
    "voice_notes": "string",
    "industry": "string",
    "core_pages": [
      {
        "url": "https://example.com",
        "title": "string"
      }
    ],
    "extracted": {
      "colors": [
        {
          "hex": "string",
          "label": "string"
        }
      ],
      "logo_urls": [
        "string"
      ],
      "background_urls": [
        "string"
      ],
      "fonts": [
        "string"
      ]
    },
    "memory_facts": [
      {
        "key": "string",
        "content": "string"
      }
    ]
  },
  "warnings": [
    "string"
  ],
  "error": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z"
}

Discard a review import's proposal or stop its crawl, or discard a one-shot import whose automatic apply failed. Takes no body. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields12 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
statusrequiredenumpending | running | preview_ready | completed | failed | cancelled`preview_ready`: the proposal waits for an accept (review imports) or is being applied (one-shot); with an `error` on a one-shot import, applying it failed: accept or cancel it.
reviewrequiredbooleanWhether it waits for an accept (false: applied when the crawl lands).
sourcerequiredobject—
brand_kit_idrequiredstring | nullThe profile it fills.
proposalrequiredobject | nullWhat the import found, once ready.
warningsrequiredstring[]—
errorrequiredstring | null—
created_atrequiredstring—
updated_atrequiredstring—
completed_atrequiredstring | null—
200400401403404409422

Search docs and guides

Search the docs and product guides.