Skip to content

Update Users

Endpoint

http
PATCH /unified/crm/users/{id}
Integrations supported
  • Salesforce

Path parameters

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

first_name
Required in
  • Salesforce
last_name
Required in
  • Salesforce
email
string
The user's email
Required in
  • Salesforce
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
REQUIRED · The user's unique identifier
name
string
The user's name
email
string
The user's email
is_active
boolean
Whether the user is active
created_at
string · date-time
The date and time of the user's creation
updated_at
string · date-time
The date and time of the user's last update
remote_data
object
Raw data returned from the remote API call.