Set a channel permission
const url = 'https://api.ebitex.io/audience/management/v1/individuals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/channel-permissions/example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"status":"example","basis":"example","note":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.ebitex.io/audience/management/v1/individuals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/channel-permissions/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "status": "example", "basis": "example", "note": "example" }'Records whether a person may be contacted on a channel (email, sms, phone or post): { "status": "granted" | "denied", "basis": "consent" | "contract" | "legitimate-interest", "note" }. It is a fact with its own source and time, separate from any browser’s consent to be recognised.
A channel with no record is unknown, and unknown means do not send. Every change is also written to the person’s interactions.
Key: an Audience management key with audience.management.write (write also needs read; erase needs both).
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Examplegenerated
{ "status": "example", "basis": "example", "note": "example"}Responses
Section titled “ Responses ”The permission as stored: { "channel", "status", "basis", "source", "recordedAtUtc", "note" }.
validation_failed: the channel, status or basis is not one of the listed values, or the note is over 500 characters.
missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired, or it was not created from the Audience settings page.
payment_required: the organization’s subscription needs attention.
scope_denied: the key lacks this route’s scope. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Audience is not enabled for the organization.
individual_not_found: no such person in this organization.
not_found: no such route.
rate_limited: the key spent its requests-per-minute budget; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.