Skip to main content

Create invitation

Creates a new invitation for a user to the organization. This function is also used to change role/team settings for a invited user identified by email address.

Header Parameters
organization-id uuid

ID of organization context this request belongs to.

Request Body REQUIRED
admin boolean

Specifies if user should be an administrator [true|false].

email email REQUIRED
organizationId uuid REQUIRED
teams uuid[]
Responses
201

Invitation successfully created

Schema OPTIONAL
admin boolean OPTIONAL
createdAt date-time OPTIONAL
createdBy uuid OPTIONAL
email string OPTIONAL
id uuid OPTIONAL
organizationId uuid OPTIONAL
status string OPTIONAL

Possible values: [CREATED, DONE, DECLINED, DELETED]

teams uuid[] OPTIONAL
validUntil date-time OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL