Delete an Opt-Out

Remove a phone number from the opt-out list, allowing messages to be sent to the recipient again.

DELETE /addressbook/optouts/{msisdn}

Replace {msisdn} with the phone number you want to remove from the opt-out list.

Required Permission

delete:Optouts

Your API key must have this permission enabled in order to use this endpoint.

Example Request

curl --location --request DELETE 'https://<hostname>/addressbook/optouts/55555555555' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with your API key.

All endpoints shown in this documentation use a sample base URL. The production API endpoint is provided by our team upon request.

Success Response (HTTP 200)

{
  "success": true
}

Not Found (HTTP 404)

Returned if the MSISDN is not present in the opt-out list.

{
  "success": false,
  "error": "Opt-out record not found"
}

If you want to send to Opted-out phone numbers you can override this by using excludeOptOuts, where supported.

Opt-outs are applied globally across all messaging endpoints.