notifications

PUT `/v1/notification-preferences`

Turn a topic's mail on or off.

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

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

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

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

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

Испробајте

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

curl -X PUT https://api.zinndigital.com/v1/notification-preferences \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "preferences": <object[]> }'

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

Детаљи

Sets your own answer, or the organization's default when for_organization is true. Your own answer outranks your organization's, in BOTH directions - so an admin silencing a topic for everyone does not lock out the one colleague who needs it. user_id is never read from the body. The row is written for the authenticated principal, because a member of an organization must not be able to silence a colleague's mail. Turning off a topic whose every message is one we are obliged to send answers 422 naming the topic and the duty - never a silent drop, which would leave you believing you had unsubscribed.

Параметри

Назив	Тип	Обавезно	Шта је ово
`org_id (query)`	`string`	Не	The organization to act on. Omitted (or empty) means your own. A reseller managing a client org must name it - defaulting silently would write the reseller's own preferences while…

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`preferences`	`object[]`	Да	—
`for_organization`	`boolean`	Не	Write the ORGANIZATION's default instead of your own answer. A separate flag rather than an omitted `user_id`, because "set this for everyone" is a different intention and must be…

Одговор

Назив	Тип	Обавезно	Шта је ово
`data`	`NotificationPreference[]`	Да	—

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

401 · 403 · 422 · 429

PUT /v1/notification-preferences