members
POST /v1/members/invitations/{invitationId}/accept
Accept an invitation addressed to your email.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/members/invitations/{invitationId}/accept \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Accepts an invitation whose email matches the **caller's verified email**, joining the organization with the invited role. The email match is the authorization — there is no secret token. Refuses an expired, revoked, already-accepted, or wrong-email invitation (422). Idempotent on the resulting membership.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
invitationId (path) | string | Да | The invitation's id. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | string | Да | — |
org_id | string | Да | — |
org_name | string | Да | The inviting organisation's display name, so an invitee can answer "accept?". |
email | string | Да | — |
role | string | Да | — |
site_grants | object[] | Да | The individual sites this invitation lends, when it was created by sharing a site with an address that had no account (`POST /v1/sites/{siteId}/collaborators`). Empty for an ord… |
status | string<pending, accepted, revoked> | Да | — |
expires_at | string | Да | — |
accepted_at | string | Не | — |
created_at | string | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422