# Update Topic

`PATCH https://api.inboxjot.com/v1/topics/{topic_id}`

Updates the fields you send and keeps the others. Needs a Full key. A key limited to one domain answers 403. Send an optional `Idempotency-Key` header to retry safely. See Idempotency.

## Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `topic_id` | string | Yes | The topic id. |

## Body Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string \| null | No | The topic name, 1 to 100 characters. |
| `description` | string \| null | No | Shown on the preference page, up to 500 characters. |
| `default_subscribed` | boolean \| null | No | Whether a new contact is subscribed to the topic until they choose. |
| `visibility` | string \| null | No | `public` shows the topic on the preference page. `private` hides it. |
| `double_opt_in` | boolean \| null | No | Whether a sign-up through the form must confirm by email first. |
| `form_enabled` | boolean \| null | No | Whether the hosted sign-up form is on. It needs a sender first. |
| `sender_name` | string \| null | No | The from name for confirmation emails, up to 100 characters. |
| `sender_email` | string \| null | No | The from address for confirmation emails. It must be on a verified domain. |
| `redirect_url` | string \| null | No | An `https://` page to show after someone signs up. |

## Response

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The topic id. |
| `name` | string | No | The topic name. |
| `description` | string \| null | No | Shown on the preference page. |
| `default_subscribed` | boolean | No | Whether a new contact is subscribed until they choose. |
| `visibility` | string | No | `public` or `private`. |
| `double_opt_in` | boolean | No | Whether a form sign-up must confirm by email. |
| `form_enabled` | boolean | No | Whether the hosted sign-up form is on. |
| `sender_name` | string \| null | No | The from name for confirmation emails. |
| `sender_email` | string \| null | No | The from address for confirmation emails. |
| `redirect_url` | string \| null | No | The page shown after someone signs up. |
| `is_default` | boolean | No | True for the default topic. Campaigns use it when no topic is set. |
| `counts` | object | No | How many contacts chose each status. |
| `counts.subscribed` | integer | No | Subscribed. |
| `counts.pending` | integer | No | Waiting to confirm. |
| `counts.unsubscribed` | integer | No | Unsubscribed. |
| `created_at` | string | No | When it was created. |
| `updated_at` | string | No | When it last changed. |

## Request

cURL:

```bash
curl -X PATCH https://api.inboxjot.com/v1/topics/top_06d2mfk8r6pn2tc8yw3hd \
  -H "Authorization: Bearer $INBOXJOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "visibility": "private"
  }'
```

## Responses

| Status | Description |
| --- | --- |
| 200 | Returns the updated topic. |
| 400 | A field is missing or invalid, or the Idempotency-Key header is not valid. |
| 401 | The API key is missing, revoked or expired. |
| 403 | The key is a Sending key or is limited to one domain, or the request comes from outside its IP allowlist. |
| 404 | The topic does not exist in this workspace. |
| 409 | A request with the same Idempotency-Key is still running. Retry after one second. |
| 413 | The body is larger than 2 MB. |
| 415 | The Content-Type header is not application/json. |
| 422 | The Idempotency-Key was already used with a different request. |
| 429 | Too many requests for this key. Wait for the seconds in the Retry-After header. |
| 500 | Something failed on our side. Retry later. |

200:

```json
{
  "id": "top_06d2mfk8r6pn2tc8yw3hd",
  "name": "Product updates",
  "description": "New features, once a month.",
  "default_subscribed": true,
  "visibility": "private",
  "double_opt_in": false,
  "form_enabled": false,
  "sender_name": null,
  "sender_email": null,
  "redirect_url": null,
  "is_default": false,
  "counts": {
    "subscribed": 3120,
    "pending": 14,
    "unsubscribed": 96
  },
  "created_at": "2026-09-02T10:12:00.000Z",
  "updated_at": "2026-09-02T10:12:00.000Z"
}
```

400:

```json
{
  "name": "validation_error",
  "status": 400,
  "message": "The request body is not valid JSON",
  "errors": [
    {
      "message": "The request body is not valid JSON",
      "location": "body"
    }
  ],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

401:

```json
{
  "name": "unauthorized",
  "status": 401,
  "message": "Unauthorized",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

403:

```json
{
  "name": "forbidden",
  "status": 403,
  "message": "This key cannot be used from 203.0.113.7",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

404:

```json
{
  "name": "not_found",
  "status": 404,
  "message": "Topic not found",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

409:

```json
{
  "name": "concurrent_idempotent_requests",
  "status": 409,
  "message": "A request with this idempotency key is still in progress. Try again later.",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

413:

```json
{
  "name": "payload_too_large",
  "status": 413,
  "message": "The request body is too large",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

415:

```json
{
  "name": "unsupported_media_type",
  "status": 415,
  "message": "The Content-Type must be application/json",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

422:

```json
{
  "name": "invalid_idempotent_request",
  "status": 422,
  "message": "This idempotency key was already used with a different request",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

429:

```json
{
  "name": "rate_limit_exceeded",
  "status": 429,
  "message": "Too many attempts. Try again later.",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

500:

```json
{
  "name": "unknown_error",
  "status": 500,
  "message": "Something went wrong. Please try again later.",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```