Removes a marketing consent. The consent is cancelled, and the state
is updated to REVOKED
.
The marketing consent entity still exists, but the recipient is no longer eligible to receive communication.
To delete a marketing consent entirely, use Delete Marketing Consent.
Required fields:
details.type
.details.email
OR details.phone
.info.lastRevokeActivity
.You can only call this method when authenticated as a Wix app or Wix user identity.
Marketing consent communication details.
Information about the last revoke.
The canceled marketing consent.
curl -X POST \
'https://www.wixapis.com/marketing-consent/v1/marketing-consent/remove' \
-H 'Authorization: <AUTH>'
-d '{
"details": {
"type": "PHONE",
"phone": "+445168993333"
}
}'
{
"marketingConsent": {
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "2",
"details": {
"type": "PHONE",
"phone": "+445168993333"
},
"state": "REVOKED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Canceling the confirmation",
"updatedDate": "2023-01-03T00:00:00Z",
"optInLevel": "SINGLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.