Members

Invite a member to the caller's tenant

Creates a pending member and its single-use invite link. The response carries invite_token; send the invitee a link built from it. The link works for 7 days, after which the member is reported as expired until an admin resends or revokes it. The inviter's email is taken from the credential that sends the invite, never from the body. Requires admin or owner (member:manage); a caller cannot invite a role above their own, and owner is reached only by promoting an existing member.

post/members

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/members
  • Auth: HTTP bearer

Request body

emailstring required
role'owner' | 'admin' | 'member' | 'viewer'
inviter_namestring

Display name of the person sending the invite, shown to the invitee. Optional; at most 80 characters.

Response

Invited

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

Changes

No recorded changes to this operation across all 1 revision of this API.