Skip to main content
POST
/
v1
/
contacts
/
subscribe
Subscribe contact
curl --request POST \
  --url https://api.useplunk.com/v1/contacts/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "id": "<string>",
  "email": "<string>"
}'
{
    "success": true,
    "contact": "80d74d13-16eb-48c5-bc2b-aae6fd5865cc",
    "subscribed": true
}

​
Body

Either the id or email is required.
​
id
string
The ID of the contact you want to subscribe
​
email
string
The email of the contact you want to subscribe

​
Headers

​
Content-Type
string
required
application/json

​
Response

{
    "success": true,
    "contact": "80d74d13-16eb-48c5-bc2b-aae6fd5865cc",
    "subscribed": true
}
⌘I