Skip to main content
POST
/
v1
/
contacts
/
unsubscribe
Unsubscribe a contact
curl --request POST \
  --url https://api.privy.com/v1/v1/contacts/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jane@example.com",
  "reason": "Contact requested removal from mailing list"
}
'
{
  "data": {
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@example.com",
    "email_permission": "unsubscribed",
    "phone_number": "+15551234567",
    "contact_phone_permission": "subscribed",
    "tags": [
      "vip"
    ],
    "custom_fields": {
      "loyalty_tier": "gold"
    },
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-04-01T12:30:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 client credentials flow. Exchange your client ID and client secret for an access token at the token URL, then include it as Authorization: Bearer <token>. See the Authentication page for details.

Body

application/json

Identify the contact with email or phone_number (not both).

​
email
string<email>

Identifies the contact to unsubscribe.

Example:

"jane@example.com"

​
phone_number
string

Identifies the contact to unsubscribe.

Example:

"+15551234567"

​
reason
string

Optional reason for unsubscribing.

Maximum string length: 500
Example:

"Contact requested removal from mailing list"

Response

Contact unsubscribed successfully.

​
data
object