Sign in
Workspace invitations

Creates a new workspace invitations for an email address if the authorized user has admin rights to the related workspace. An email containing a sign up link will be send to the user.

post/api/workspaces/invitations/workspace/{workspace_id}/

Path parameters

workspace_idinteger required

Creates a workspace invitation to the workspace related to the provided value.

Request body

emailstring email required

The email address of the user that the invitation is meant for. Only a user with that email address can accept it.

permissionsstring

The permissions that the user is going to get within the workspace after accepting the invitation.

base_urlstring uri required

The base URL where the user can publicly accept his invitation.The accept token is going to be appended to the base_url (base_url '/token').

captcha_tokenstring

The captcha response token, required when captcha is enabled.

Response

idinteger required
workspaceinteger required

The workspace that the user will get access to once the invitation is accepted.

emailstring email required

The email address of the user that the invitation is meant for. Only a user with that email address can accept it.

permissionsstring

The permissions that the user is going to get within the workspace after accepting the invitation.

created_onstring date-time required

Changes

Changed in 1 of the 6 revisions of this API.14

  • 0c490e5b0c7f14See the full diff
    • ●

      added the new ERROR_CAPTCHA_VERIFICATION_FAILED enum value to the error response property for the response status 400

      response-property-enum-value-added

    • ○

      added the new optional request property captcha_token (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property captcha_token (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property captcha_token (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog