Update a user's access permissions for an account

put

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

Modifies the access rights of an existing collaborator for the specified account.
This can involve changing their role for specific projects or altering which projects they can access.
Identifies the ACTIVE collaborator by user_id.

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 identifier of an ACTIVE collaborator (user_id resolving to an active collaborator) and the replacement list of project accesses and their corresponding roles (e.g., 'admin', 'editor') for that user within the account.

Identifies an ACTIVE collaborator. Pending invitations have no user id and are addressed by email through the invitations endpoints.

user_id

string

required

The unique system identifier for an active Convert user.

first_name

string

length ≤ 200

Collaborator's first name

last_name

string

length ≤ 200

Collaborator's last name

accesses

array of objects

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

accesses

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