---
title: "Create an opt-out"
method: POST
path: "/v3/messages/opt-outs"
tags: ["SMS and MMS"]
---

# Create an opt-out

`POST /v3/messages/opt-outs`

## Request

- Base URL: `https://api.wavix.com`
- URL: `https://api.wavix.com/v3/messages/opt-outs`
- Auth: HTTP bearer

Opts a phone number out of receiving messages from a Sender ID, a 10DLC campaign, or all outbound messages.

## Request body

- OptOutCreateRequest
  - `opt_out` OptOut, required
    - `number` string, required: Phone number to opt out.
    - `sender_id` string: Sender ID. If omitted, the phone number is opted out of all messages.

## Response `201`

Returns a success confirmation. The opt-out is created.

- SuccessResponse
  - `success` boolean, required: Indicates whether the request was successful.

## Other responses

- `400`: Request failed. Missing or invalid parameter <param_name>
- `401`: Unauthorized
- `403`: Request failed. The feature is disabled for your account.
- `404`: Request failed. An object with the specified ID is not found.
- `422`: Validation error

## Changes

- **2026-09-14** `d4db3aae3627`: 1 breaking
  - the request's body type changed from no type to `object`
- **2026-09-08** `6a89c962481c`: 1 breaking, 3 info
  - the response's body type changed from no type to `object` for status `201`
  - removed `#/components/schemas/SuccessResponse, subschema #2` from the response body `allOf` list for the response status `201`
  - added the non-success response with the status `401`
  - added the required property `success` to the response with the `201` status
- **2026-05-25** `33be77905120`: 1 info
  - the endpoint scheme security `bearerAuth` was added to the API
- **2026-04-20** `2e48fd9894e1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/wavix/apis/wavix-apis/changes/v3/messages/opt-outs/post.md)

---

[API](https://skmtc.dev/wavix/apis/wavix-apis.md) - [All operations](https://skmtc.dev/wavix/apis/wavix-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/wavix/apis/wavix-apis/revisions/f2dde79f05ab?raw)