members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението members.invite; ключ без него се отхвърля с 403, а не с 404.

Където отива идентификаторът на вашата организация

Този краен пункт приема org_id като поле в JSON тялото.

ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

curl -X POST https://api.zinndigital.com/v1/members/invitations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "role": <string> }'

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

Invites an email (the person need not exist yet — users are Keycloak subjects) to join with a role. The role is validated to be one the inviter is themselves permitted to grant: a role holding any permission the inviter lacks in that organization is refused (422), so members.invite is not a ladder to owner. A re-invite of the same email refreshes the pending invite. Emits member.invited so the invitation email is sent. Requires members.invite in the target org.

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`email`	`string`	Да	—
`role`	`string`	Да	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Не	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Отговор

Име	Тип	Задължително	Какво представлява
`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…
`status`	`string<pending, accepted, revoked>`	Да	—
`expires_at`	`string`	Да	—
`accepted_at`	`string`	Не	—
`created_at`	`string`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 422 · 429