members
POST /v1/members/invitations/{invitationId}/accept
Accept an invitation addressed to your email.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/members/invitations/{invitationId}/accept \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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