invitations

Invite people by email

Create or merge up to 50 invitations in one call. Each invitee targets one workspace (defaulting to the account's org_default) at one role. Structural violations — a personal-workspace target, or viewer into org_default — are a 422; a rank over-reach or an email-policy failure is per-email results[].outcome data, never an HTTP error, as is an organization with no free seat (outcome: rejected, reason: seat_capacity_exhausted; the invite is not kept). An archived target workspace refuses the whole batch with 409 workspace_archived, since its roster is closed and the invite could never seat anyone. members_invite.

post/registry/v1/invitations

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
  • Auth: HTTP bearer

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

Response

The per-email outcome breakdown.

Changes

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