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, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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 | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422