Team

Create a team invitation

Invite a user to join your team by email. An invitation email is sent automatically. Returns 409 if the user already belongs to a team or an invitation is already pending.

post/profile/team/invitations

Request body

emailstring email required

namestring nullable

role'member' | 'admin'

Example request

{
  "email": "newmember@example.com",
  "name": "Jane Doe",
  "role": "member"
}

Response

Invitation created

idinteger required

Invitation ID.

invited_emailstring email required

Email address of the invited user.

invited_namestring nullable

Name of the invited user.

rolestring required

Assigned role: 'member' or 'admin'.

statusstring required

Invitation status: 'pending', 'accepted', 'revoked', or 'expired'.

expires_atstring date-time required

Expiration date of the invitation.

created_atstring date-time required

Creation date of the invitation.

accepted_user_idinteger nullable

ID of the user who accepted the invitation.

tokenstring nullable

Invitation token (only returned on creation).

Changes

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