POST
Accept an invitation
No sign-in needed Cannot be undone For: Administrator Conditions
  • No sign-in is needed.
  • The token must be a valid invitation token, not expired and not blacklisted.
  • The token must be the latest one sent for the invitation: inviting the same email again renews the pending invitation and older links stop working.
  • The invitation must still be pending and not past its expiry date.
  • The person must not already be a member of the space (company, client or organization) of the invitation.
  • When the email has no account yet, first_name, last_name (3 to 250 characters), phone_number (7 to 15 digits with an optional leading +, not used by any account) and a strong password (8 or more characters with lower case, upper case, a digit and a symbol) are required; when an account exists these fields are not used to create anything, but any value sent is still format-checked, and a phone number that already belongs to an account is refused even if it is the person’s own.
  • The invitation must still carry at least one profile, and each profile must still belong to the space; otherwise the acceptance is rolled back.
What else happens
  • Creates the account for the invited email when none exists, with the email already marked verified; the email comes from the invitation, not from the body.
  • Gives the person an active assignment for each profile of the invitation in the invitation’s space; none is the default.
  • Creates the member (company member, client member or organization member), active, with the pseudo of the invitation or first and last name; a numbered suffix such as (2) is added when the pseudo was taken meanwhile.
  • Marks the invitation accepted, stamps accepted_at and links it to the new member.
  • Invalidates the invitation token after the transaction commits, so the link cannot be reused.
Part of Invite and onboard members.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

token
string
required

Invitation token from the emailed link. It is valid until the invitation's expiry and only if no newer invitation was sent to the same email.

Body

application/json
first_name
string | null

First name of the new person, 3 to 250 characters. Required when the invited email has no account yet; not used when an account exists.

Maximum string length: 255
last_name
string | null

Last name of the new person, 3 to 250 characters. Required when the invited email has no account yet; not used when an account exists.

Maximum string length: 255
password
string | null

Password of the new account: at least 8 characters with lower case, upper case, a digit and a symbol. Required when the invited email has no account yet; not used when an account exists.

phone_number
string | null

Phone number of the new account, optional plus sign followed by 7 to 15 digits. Required when the invited email has no account yet. Must not belong to any existing account.

Response