Skip to navigation
PlatformSpaceMembers

Invite a member

View as MarkdownOpen in Claude

Sends an invitation to join the space. The member exists immediately with activated: false and activates by accepting the invitation.

Only admin and employee can be assigned; owner is rejected with invalid_role. Give a new member access to projects with Enable a member for a project.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder’s role in the space is the whole authorization decision.

Authentication

AuthorizationBasic

Personal access token authentication for space-wide administration.

Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project's: it is created from your user menu in the Dashboard, is prefixed pat_, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space.

Example:

Authorization: Basic base64(:pat_...)

Request

This endpoint expects an object.
emailstringRequired

The email address to invite. Must be a valid address that does not already belong to a member of the space (already_a_member).

roleenumRequired

The role to assign: admin or employee. owner cannot be assigned (invalid_role).

Allowed values:
namestringOptional
The member's name.

Response

The request has succeeded and a new resource has been created as a result.
typeenum

The object type. Always member.

Allowed values:
idstringformat: "uuid"
The unique identifier of the membership, used in the path of the member endpoints.
emailstring
The member's email address.
namestring or null

The member's name, or null when none was given.

roleenum
The member's role in the space.
Allowed values:
job_titleenum or null

The member's job title, or null when not set.

Allowed values:
activatedboolean

Whether the member has accepted the invitation. false until the invitation is accepted.

last_logged_indatetime or null

The date and time the member last signed in, or null if they never have.

created_atdatetime
The date and time when the membership was created.
updated_atdatetime
The date and time when the membership was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error