---
title: "Add a number to the opt-out list"
method: POST
path: "/v1/opt-outs"
tags: ["Opt-outs"]
---

# Add a number to the opt-out list

`POST /v1/opt-outs`

## Request

- Base URL: `https://www.chatrail.dev`
- URL: `https://www.chatrail.dev/v1/opt-outs`
- Auth: HTTP bearer

For someone who has asked you, outside WhatsApp, to stop. Adding a number that is already on the list succeeds and changes nothing. Sending to it is refused from then on, including anything already queued or scheduled.

## Request body

- object
  - `phone` string, required

## Response `200`

Already on the list.

## Other responses

- `201`: Added.
- `400`: Not a valid phone number.

---

[API](https://skmtc.dev/chatrail/apis/chatrail-api.md) · [All operations](https://skmtc.dev/chatrail/apis/chatrail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatrail/apis/chatrail-api/revisions/acc5b88c6f59?raw)