---
title: "Cancel a brand kit import"
description: "Discard a review import's proposal or stop its crawl, or discard a one-shot import whose automatic apply failed. `POST /api/v1/brand-kits/imports/{id}/cancel`"
url: https://www.unitpost.com/docs/email/post-brand-kits-imports-id-cancel
section: "Email API reference"
updated: 2026-10-13
---
# Cancel a brand kit import

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

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.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | — |

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `id` | string | yes | — |
| `status` | enum | yes | `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. One of: `pending`, `running`, `preview_ready`, `completed`, `failed`, `cancelled`. |
| `review` | boolean | yes | Whether it waits for an accept (false: applied when the crawl lands). |
| `source` | object | yes | — |
| `brand_kit_id` | string \| null | yes | The profile it fills. |
| `proposal` | object \| null | yes | What the import found, once ready. |
| `warnings` | string[] | yes | — |
| `error` | string \| null | yes | — |
| `created_at` | string | yes | — |
| `updated_at` | string | yes | — |
| `completed_at` | string \| null | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | The import (`cancelled`). |
| 400 | The body isn't JSON. |
| 401 | Missing or invalid API key. |
| 403 | Insufficient scope (`branding:write` is opt-in on a key). |
| 404 | Brand import not found. |
| 409 | A one-shot import still running or applied, or one already finished. |
| 422 | A body or an unknown query key was sent. |

## Example request

```bash
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'
```

## Example response (200)

```json
{
  "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"
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/email/post-brand-kits-imports-id-cancel
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json