invitations

Edit a pending invite's role or target

Rewrite a pending invitation's role and/or target workspace in place. The body is { role?, workspace_id? } with at least one present; the email is never editable. The change re-runs all three gates against the (possibly new) target and respects the one-live-invite-per-(workspace, email) uniqueness. members_invite.

patch/registry/v1/invitations/{invitation_id}

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/invitations/{invitation_id}
  • Auth: HTTP bearer

Path parameters

invitation_idstring required

Invitation handle (invitation_…)

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Request body

rolestring nullable

The new role: admin, builder or viewer. Legacy member is accepted as an alias for builder.

workspace_idstring nullable

The new target workspace handle (workspace_…).

Response

The updated invitation.

accepted_atstring nullable

Value of the accepted_at field.

created_atstring required

Value of the created_at field.

emailstring required

Value of the email field.

email_statusstring required

sent | failed | not_sent.

expires_atstring required

Value of the expires_at field.

invitation_idstring required

Stable identifier of the related invitation resource.

invited_bystring required

Value of the invited_by field.

joined_user_idstring nullable

Stable identifier of the related joined user resource.

rolestring required

Value of the role field.

sent_atstring nullable

Value of the sent_at field.

statusstring required

pending | accepted | revoked | expired (the last derived from the TTL).

workspace_idstring required

Stable identifier of the related workspace resource.

Changes

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