API End Points

Unsubscribe Candidate

post
https://apiv2.{domain}.ai/api/v2/core/profiles//unsubscribe

Unsubscribe all emails and phone numbers on a candidate profile from the given communication channels

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Profile ID of the candidate being unsubscribed

Body Params
channels
array of strings | null

Channels to unsubscribe from: email, campaign, sms, whatsapp. Defaults to all channels when omitted or empty

channels
Headers
string
required

The secret key to access the api. It starts with the bearer token

Response

Updated 6 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago