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
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Organization to invite the person to. |
email | string | Yes | Email of the person. |
role | string | Yes | owner, admin or member. Admins can only invite member. |
organization_role_id | integer | No | Custom role to assign on accepting. |
first_name | string | No | Pre-filled first name. |
last_name | string | No | Pre-filled last name. |
avatar_url | string | No | Pre-filled profile picture, uploaded for this organization's invitations. |
Request
Response
json
Errors
| Status | When |
|---|---|
400 Bad Request | The 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 Forbidden | The key's user is a member, is an admin inviting a non-member role, or does not belong to the organization. |
500 Internal Server Error | The 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.