Accept an invite (single-use token)
Accept an invite (single-use token): CustomDomain™ API reference in the members group. Covers request parameters, the request body, responses and error codes.
Accepts the invite and returns the member with a member-scoped API key for the inviter's tenant. The token is the capability, so no API key is needed; when email is supplied it must match the invited email. The token is spent on success, once. A second accept that races the first, or one racing a resend that replaced the link, is refused with 409. A repeat after the accept has finished finds no invite and answers 404, as does a link for an invite that was removed. A pending invite whose link has lapsed is refused with 410 invite_expired.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/members:accept" \ -H "Content-Type: application/json" \ -d '{ "token": "string" }'{ "id": "string", "tenant_id": "string", "email": "string", "role": "owner", "status": "active", "invited_by": "string", "inviter_email": "string", "inviter_name": "string", "invite_sent_at": "2019-08-24T14:15:22Z", "invite_expires_at": "2019-08-24T14:15:22Z", "invite_token": "string", "accepted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "application_id": "string", "api_key": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}