Add an unsubscribed contact

Unsubscribes a contact from a specific program's Outreach communications (Workflows, Newsletters, and Bulk Mail) on behalf of a partner.

Parameters

---

PartnerId required

The unique identifier for the Partner associated with this action.

---

UserEmail required

The email address of the contact to unsubscribe.

Returns

---

Returns a confirmation object with the Status and Uri on success, or an error object if the request is invalid.

Example request

---

cURL

curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/<CampaignId>/UnsubscribedContacts' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'PartnerId=1111' \
  -d '[email protected]'

Example Response

---

JSON

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/<CampaignId>/UnsubscribedContacts/{GeneratedRecordID}"
}