WorkspaceInvitation

Invite user to workspace

Create link or email based workspace invite. For email invites, invite emails are sent to the invited users.

post/workspaces/invitations

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/workspaces/invitations
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Request body

invitee_emailstring

The e-mail address allowed to accept a EMAIL based invitation. Required for EMAIL based invitations.

allow_list_emailsstring[]

The e-mail addresses allowed to accept a LINK based invitation. Required for LINK based invitations.

validity_secondsinteger

The number of seconds this invite should be valid for

app_hoststring

Mabl app site host. Defaults to current app.

invite_type'email' | 'link'

Response

The created invitation

idstring

The ID of the organization invitation

created_timeinteger

Time at which the organization invitation was created

created_by_idstring

The ID of the user who created this organization invitation

last_replayed_timeinteger

Time at which the organization invitation was last replayed (re-sent)

last_updated_timeinteger

Time at which the organization invitation was last updated

last_updated_by_idstring

The ID of the user who last updated this organization invitation

invitee_emailstring

The e-mail address to which the invitation should be sent (singular recipient)

invite_type'email' | 'link'
allow_list_emailsstring[]

The e-mail addresses that are allowed to accept this invitation (when invite supports multiple invitees)

expiration_timeinteger

The timestamp that this invitation is valid until (max 7 days)

acceptance_api_key_idstring

ID of key that backs this invite.

accepted_by_emailsstring[]

Email addresses that have accepted this invitation (link-type only)

accept_uristring

The URI that the user should request in order to accept the invitation. Only returned upon creation for Link type invites, otherwise passed via invite email.

accept_uri_hoststring

Mabl app site host. Defaults to current app.

accept_uri_query_stringstring

Non-secret query parameters chosen at creation to populate the invite link.

is_expiredboolean

Whether this invitation has effectively expired (server-resolved)

created_by_namestring

Display name of the user who created this invitation (server-resolved)

Changes

No recorded changes to this operation across all 37 revisions of this API.