# Inspect sending rules

GET /v1/inboxes/{inbox_id}/sending-policy

Source: https://cherami.to/docs/api/inboxes/get-sending-policy



{/* Generated from apps/web/openapi. Edit the contract, not this file. */}

`GET /v1/inboxes/{inbox_id}/sending-policy`

Requires an [API key](https://cherami.to/docs/api#authentication): `Authorization: Bearer YOUR_CREDENTIAL`.

Shows the inbox's recipient restrictions. They apply to every way of sending: send, reply, reply-all, forward and drafts.

With `enabled: false` the inbox can send to anyone, even if addresses or domains are saved. With `enabled: true`, every To, Cc and Bcc recipient must match an entry in `addresses` or `domains`, or the send is refused with `403 recipient_not_allowed`; with both lists empty, the inbox can't send.

An address entry matches exactly: the local part is case-sensitive, and plus tags and dots count. A domain matches without regard to case and only itself, not its subdomains; international domains are listed in punycode.

These rules can be changed only in [Account → Sending rules](https://cherami.to/account/sending-rules), not through the API. [Sending rules guide](https://cherami.to/docs/guides/sending-rules)

## Parameters [#parameters]

| Parameter  | Location | Required | Type   | Meaning                                  |
| ---------- | -------- | -------- | ------ | ---------------------------------------- |
| `inbox_id` | path     | Yes      | string | Cherami resource ID returned by the API. |

## curl example [#curl-example]

Supply `CHERAMI_API_KEY` privately.

```sh
curl --silent --show-error --include --request GET \
  "https://cherami.to/v1/inboxes/INBOX_ID/sending-policy" \
  --header "Authorization: Bearer $CHERAMI_API_KEY"
```

## Responses [#responses]

### HTTP 200 [#http-200]

Success.

* `X-Request-ID`: Identifies this request; include it when reporting a problem.

Content type: `application/json`.

[Policy](#schema-policy)

```json
{
  "inbox_id": "11111111-1111-4111-8111-111111111111",
  "enabled": true,
  "addresses": [],
  "domains": [],
  "revision": 0
}
```

### HTTP 401 [#http-401]

`unauthorized`: Send a valid API key as `Authorization: Bearer <key>`. If the key stopped working, get a new one through [recovery](https://cherami.to/docs/guides/recovery).

* `X-Request-ID`: Identifies this request; include it when reporting a problem.
* `WWW-Authenticate`: `"Bearer"`

Content type: `application/json`.

[Error](#schema-error)

### HTTP 404 [#http-404]

`not_found`: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.

* `X-Request-ID`: Identifies this request; include it when reporting a problem.

Content type: `application/json`.

[Error](#schema-error)

### HTTP 500 [#http-500]

`internal_error`: The operation failed. Retry a read; after a write the change may have happened, so recover as [retry by operation](https://cherami.to/docs/api/errors#retry-by-operation) describes.

* `X-Request-ID`: Identifies this request; include it when reporting a problem.

Content type: `application/json`.

[Error](#schema-error)

## Schema: Policy [#schema-policy]

| Field       | Required | Type            | Meaning and constraints                                      |
| ----------- | -------- | --------------- | ------------------------------------------------------------ |
| `inbox_id`  | Yes      | string          | Cherami resource ID.                                         |
| `enabled`   | Yes      | boolean         |                                                              |
| `addresses` | Yes      | array of string | `maxItems`: `100`                                            |
| `domains`   | Yes      | array of string | `maxItems`: `100`                                            |
| `revision`  | Yes      | integer         | Saved policy version; zero when unconfigured. `minimum`: `0` |

## Schema: Error [#schema-error]

| Field   | Required | Type   | Meaning and constraints |
| ------- | -------- | ------ | ----------------------- |
| `error` | Yes      | object |                         |

### `error` fields [#error-fields]

| Field     | Required | Type   | Meaning and constraints                                               |
| --------- | -------- | ------ | --------------------------------------------------------------------- |
| `code`    | Yes      | string | Code to handle. Handle a code you don't recognize by its HTTP status. |
| `message` | Yes      | string | Explanation of this case; its wording can change.                     |

[Errors, limits and pagination](https://cherami.to/docs/api/errors) · [Download OpenAPI 3.1](https://cherami.to/openapi.json)
