Skip to content

Delete subscription state by email address or phone number

delete

/users/subscription

Use this endpoint to delete the subscription state value based on an email address or phone number.

Request parameters

Parameter Required Data Type Description
email Yes String The email address of the user (must include at least one address and at most 50 addresses).
phone Yes String The phone number of the user (must include at least one phone number and at most 50 phone numbers). We recommend providing this in E.164 format.

Example request

1
2
3
4
5
6
7

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
  {phone: "+12125551212"},
  {email: "[email protected]"},
  {phone: "+17185551212"}
}

Response

1
2
3
4

{
  "status": "The emails and/or phone numbers have been queued for deletion",
  "message": "success"
}
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!