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

Documentation Index

Fetch the complete documentation index at: https://help.privy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Path Parameters

​
id
string
required

The contact's unique identifier (returned as id in contact responses).

Body

application/json
​
reason
string

Optional reason for unsubscribing.

Maximum string length: 500
Example:

"Contact requested removal from mailing list"

Response

Contact unsubscribed successfully.

​
data
object