DELETE
/v1/comms/opt-outs/{address}Take an address off the do-not-contact list
Removes one address from the do-not-contact list so sends to it are allowed again. Admins only. The address is in the path in any spelling; reason is required in the query and is written to the activity entry naming who removed it. An address not on the list is a 404. Only do this when the person has asked to hear from the workspace again.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
addresspath · stringrequired
reasonquery · stringoptional
Responses
200application/json
the action's answer
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired