EIeightfold
Profile

Unsubscribe Candidate

Changed on

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

post/api/v2/core/profiles/{profileId}/unsubscribe

Request

Path parameters

profileIdstring required

Profile ID of the candidate being unsubscribed

Headers

Authorizationstring required

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

Request body

channelsstring[] nullable

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

Response

OK

phonesUnsubscribedinteger nullable

Number of distinct phone numbers suppressed on at least one requested channel. Use channelResults to see whether every channel succeeded for them

emailsUnsubscribedinteger nullable

Number of distinct email addresses suppressed on at least one requested channel. Use channelResults to see whether every channel succeeded for them

channelsstring[] nullable

Channels the suppression was applied to

Changes