Update Users

This request enables the update of an existing user account. If the user does not exist, this request will send an invite to the user. It is important to note that the user's first name, last name, and email cannot be updated.

IMPORTANT: Fields within the user object are optional. Any fields provided will be used to pre-fill the associated onboarding questions. Data provided must be an exact match to onboarding answers in the Vygo platform.

Each field provided replaces the user's existing answers for that field in full. Send a field only when you intend to set its complete new value. Answers are matched against your organisation's active tags by label or code. Use the Tag Groups request to retrieve the valid values for each field, and the Users request to read a user's current answers before updating. An answer that does not match any tag is silently ignored: the request still reports success and the unmatched value is not applied. Sending an empty array for a field clears all of the user's answers for that field. Free-text answers to tag groups that allow custom answers cannot be set through this request. Sending the free text will not match a tag; keep the group's own tag label (e.g. Other) in the answers you send to preserve an existing custom answer.

Body Params
users
array of objects
required
length between 1 and 200

Min items: 1 | Max items: 200

users*
string
required
length between 1 and 100

Max length: 100

user
object

Details that your would like to update. All fields are optional.

Headers
string
required

You must provide your API key in the header of each request.

Responses

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