Invite a new collaborator (pending invitation)

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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. first_name and last_name are required and must be 1-200 characters long. A custom message can be included in the invitation email.

Invitee's names, used in the invitation email. Scoped to the invitation request bodies only:
responses and active-collaborator bodies share BaseAccountUserAccesses, and stored legacy
records may hold empty names.

string
required
length between 1 and 200

Invitee's first name

string
required
length between 1 and 200

Invitee'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.

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

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json