Create an invitation

Invites a person by email to join the organization. The API sets status to pending and expires_at to 24 hours from now, and emails the person a link to accept.

Endpoint

POST
/organizations-users-invites

Body

NameTypeRequiredDescription
organization_idintegerYesOrganization to invite the person to.
emailstringYesEmail of the person.
rolestringYesowner, admin or member. Admins can only invite member.
organization_role_idintegerNoCustom role to assign on accepting.
first_namestringNoPre-filled first name.
last_namestringNoPre-filled last name.
avatar_urlstringNoPre-filled profile picture, uploaded for this organization's invitations.

Request

Response

json

Errors

StatusWhen
400 Bad RequestThe plan's seat limit is reached (active members plus pending invitations), avatar_url is not an invitation upload of this organization, or a field is invalid.
403 ForbiddenThe key's user is a member, is an admin inviting a non-member role, or does not belong to the organization.
500 Internal Server ErrorThe email already belongs to a member of the organization (message User is already a member of this organization).

Report an issue with this documentation

Please log in to report issues with our documentation.