campaigns

POST `/v1/campaigns/suppressions`

Add an address to the suppression list.

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Где се уноси ID ваше организације

Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

curl -X POST https://api.zinndigital.com/v1/campaigns/suppressions \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "reason": <string<unsubscribed, bounced, complained, staff_blocked>> }'

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

unsubscribed applies to your own campaigns. bounced, complained and staff_blocked are facts about the ADDRESS and are stored platform-wide whatever scope you send them under — continuing to mail a hard bounce damages delivery for every other customer sending from the same domain. Idempotent on (scope, address, purpose).

Параметри

Назив	Тип	Обавезно	Шта је ово
`org_id (query)`	`string`	Не	—

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`email`	`string`	Да	—
`reason`	`string<unsubscribed, bounced, complained, staff_blocked>`	Да	—
`note`	`string`	Не	—

Одговор

Назив	Тип	Обавезно	Шта је ово
`id`	`string`	Да	—
`email`	`string`	Да	—
`reason`	`string`	Да	—

Грешке које ова крајња тачка може вратити

401 · 403 · 422

POST /v1/campaigns/suppressions