Members

Accept an invite (single-use token)

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. A pending invite whose link has lapsed is refused with 410 invite_expired.

post/members:accept

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/members:accept
  • Auth: none required

Request body

tokenstring required
emailstring

When supplied, must match the invited email.

user_idstring

The accepting user's id in the calling application, recorded as invited_by.

Response

Accepted

idstring required
tenant_idstring required
emailstring required
role'owner' | 'admin' | 'member' | 'viewer' required
status'active' | 'pending' | 'expired' required

active once accepted, pending while the invite link works, expired once it has lapsed.

invited_bystring

The accepting user's id in the calling application, when one was supplied at accept.

inviter_emailstring

Who sent (or last re-sent) the invite, resolved from the sending credential.

inviter_namestring

The sender's display name, when one was supplied.

invite_sent_atstring date-time

When the current invite link was issued.

invite_expires_atstring date-time

When the current invite link stops working. Absent for members never invited by link.

invite_tokenstring

The single-use invite token. Present only in the invite, resend and get-invite responses, never in the roster.

accepted_atstring date-time
created_atstring date-time required
application_idstring required

The inviter tenant's default application.

api_keystring required

Member-scoped API key for the inviter's tenant; shown once.

Changes