Members

Change a member's role (owner-protected)

patch/members/{id}

Request

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

Path parameters

idstring required

Request body

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

Response

Updated

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.