PATCH /sites/{site_id}/users/{user_id}

Update a User by ID

Required scope | users:write

The email and password fields cannot be updated using this endpoint

Servers

Path parameters

Name Type Required Description
site_id String Yes

Unique identifier for a Site

user_id String Yes

Unique identifier for a User

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
accessGroups[] Array No

An array of access group slugs. Access groups are assigned to the user as type admin and the user remains in the group until removed.

data Object No
data.accept-communications Boolean No

Boolean indicating if the user has accepted to receive communications

data.name String No

The name of the user

data.accept-privacy Boolean No

Boolean indicating if the user has accepted the privacy policy

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.