# Cancel Email

`POST https://api.inboxjot.com/v1/emails/{email_id}/cancel`

Cancels a scheduled email so it never goes out. Only an email with the `scheduled` status can change. Needs a Full key. Send an optional `Idempotency-Key` header to retry safely. See Idempotency.

## Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `email_id` | string | Yes | The email id, such as `eml_06d2mfk8r4tq9xv2bnc7s`. |

## Response

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The email id. |
| `status` | string | No | Now `canceled`. |

## Request

cURL:

```bash
curl -X POST https://api.inboxjot.com/v1/emails/eml_06d2mfk8r4tq9xv2bnc7s/cancel \
  -H "Authorization: Bearer $INBOXJOT_API_KEY"
```

Node.js:

```javascript
import { Inboxjot } from 'inboxjot';

const inboxjot = new Inboxjot();

await inboxjot.emails.cancel('eml_06d2mfk8r4tq9xv2bnc7s');
```

Rust:

```rust
use inboxjot::Inboxjot;

let client = Inboxjot::from_env()?;

client.emails().cancel("eml_06d2mfk8r4tq9xv2bnc7s").await?;
```

Go:

```go
client := inboxjot.NewClient("")

email, err := client.Emails.Cancel(ctx, "eml_06d2mfk8r4tq9xv2bnc7s")
```

Python:

```python
from inboxjot import Inboxjot

inboxjot = Inboxjot()

inboxjot.emails.cancel("eml_06d2mfk8r4tq9xv2bnc7s")
```

## Responses

| Status | Description |
| --- | --- |
| 200 | Canceled the email. |
| 400 | A parameter 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 the request comes from outside its IP allowlist. |
| 404 | The email does not exist in this workspace. |
| 409 | The email is not scheduled, or a request with the same Idempotency-Key is still running. |
| 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": "eml_06d2mfk8r4tq9xv2bnc7s",
  "status": "canceled"
}
```

400:

```json
{
  "name": "invalid_idempotency_key",
  "status": 400,
  "message": "Idempotency-Key must be 1 to 256 printable ASCII characters",
  "errors": [],
  "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": "Email not found",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

409:

```json
{
  "name": "conflict",
  "status": 409,
  "message": "Only a scheduled email can change",
  "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"
}
```