Invite a new collaborator to an account

post

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

Sends an invitation to a user (identified by email) to become a collaborator on the specified account. The request defines the initial set of projects and the role the user will have for those projects. The user will receive an email to accept the invitation.

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

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Details the access permissions for a single user within a specific account, including their roles for various projects.

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.