Invite a new collaborator (pending invitation)

post

https://api.convert.com/api/v2/accounts/{account_id}/users-accesses/invitations/add

Creates a pending collaborator invitation for the account and sends the invitation email.
Pending invitations are stored separately from accepted accesses and are always addressed by
email, since a collaborator has no user id until the invitation is accepted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

Body Params

Contains the invitee's email, first name, last name, and the initial list of project accesses and their roles. A custom message can be included in the invitation email.

first_name

string

length ≤ 200

Collaborator's first name

last_name

string

length ≤ 200

Collaborator's last name

accesses

array of objects

required

(Misplaced Array) Defines the role for a specific project.

accesses*

string

required

length ≤ 100

The email address of the collaborator or invitee.

custom_message

string

length ≤ 200

(For invitations) A custom message to include in the invitation email sent to a new collaborator.

expand

array of objects

Specifies linked objects to expand in the response, e.g., 'accesses.project'.
Refer to the Expanding Fields section.

expand

Allowed:

Responses

200Details a single pending invitation - the invitee, and the accesses they will receive once they accept. Carries no user id, since an invitee has no Convert user yet.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.