Delete an opt-out

Removes an opt-out so the number can be messaged again. Use List opt-outs with search to find the opt-out ID for a number.

DELETE

https://app.touchsms.com.au/api/v2/optouts/{optout}

Authorization

basicAuth
HTTP
required

Path parameters

optout
integer
required
Opt-out ID.

Returns

200

Opt-out deleted. The response body is empty.

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

JSON

message
string
required

Delete an opt-out

curl --request DELETE \
  --url https://app.touchsms.com.au/api/v2/optouts/12345 \
  --header 'Authorization: Basic <credentials>'

const url = 'https://app.touchsms.com.au/api/v2/optouts/12345';
const options = {method: 'DELETE', headers: {Authorization: 'Basic <credentials>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "message": "Unauthenticated."
}

{
  "message": "This action is unauthorized."
}

{
  "message": "Not Found"
}