Organization invitations

An invitation asks someone, by email, to join your organization with a role. Creating one emails the person a link; when they accept it they become a member of the organization. Invitations expire 24 hours after they are created.

Endpoints

MethodPathDescription
GET/organizations-users-invitesList invitations
GET/organizations-users-invites/:idGet an invitation
POST/organizations-users-invitesCreate an invitation
PATCH/organizations-users-invites/:idUpdate an invitation
DELETE/organizations-users-invites/:idCancel an invitation

Reads are limited to your API key's organization. Pass organization_id as a filter to work with one organization.

Who can invite

The checks use the role of the API key's user in the organization:

RoleCan invite / cancel
ownerAny role (owner, admin, member).
adminOnly member invitations.
memberNothing (403 Forbidden).

The invitation object

json

organization, created_by_user and user_exists (whether an AchieveApex account already exists for email) are added on list and get.

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization the person is invited to. Required on create; cannot be changed.
emailstringEmail of the person invited. Required on create. Stored lowercase and trimmed.
created_by_user_idintegerRead-only. User who sent the invitation (the API key's user).
rolestringRole the person gets on accepting: owner, admin or member. Required on create.
organization_role_idinteger | nullCustom role (granular permissions) assigned on accepting, if any.
first_namestring | nullFirst name to pre-fill on the new user's profile. Max 255 characters.
last_namestring | nullLast name to pre-fill on the new user's profile. Max 255 characters.
avatar_urlstring | nullProfile picture to pre-fill. Must be a file uploaded for this organization's invitations (a key starting with organizations/<organization_id>/invites/).
statusstringRead-only on create. pending, accepted or rejected. Starts as pending.
expires_atstring (date-time)Read-only on create. 24 hours after creation. Expired invitations cannot be accepted.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the invitation is cancelled.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.