PATCH /user_attributes/{id}
Updates an organization user attribute and returns the updated user attribute. Requires the user_attributes:write scope.
Servers
- https://api.retool.com/api/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
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 |
|---|---|---|---|
operations[] |
Array | Yes |
A list of operations to apply to the user attribute. See the JSON PATCH specification for more details. |
operations[].op |
String | Yes |
Valid values:
|
operations[].value |
No |
A JSON value |
|
operations[].path |
String | Yes | |
update_existing |
Boolean | No |
Whether to update existing users with the updated attribute. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.