Update the accesses of a pending invitation

put

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

Updates the accesses of an existing pending invitation, identified by email.
No email is sent. The invitation's activation hash and original creation time are preserved,
so an activation link that has already been delivered stays valid. Returns 404 if no pending
invitation exists for that email.

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 pending invitee's email and the full replacement list of project accesses. The list must not be empty. No email is sent.

Replacement access list for the invitation. Omit accesses entirely to leave the current
grants untouched and update only the other fields; when it is present it must contain at
least one entry, since an invitation with no accesses is not listable and would be
orphaned.

string

required

length ≤ 100

The email address of the collaborator or invitee.

first_name

string

length ≤ 200

Collaborator's first name

last_name

string

length ≤ 200

Collaborator's last name

accesses

array of objects

length ≥ 1

(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

Language

Credentials

URL

Loading…

Response

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

application/json

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.