Appearance

Update Accounts ​

Endpoint ​

http
PATCH /unified/crm/accounts/{id}
Integrations supported
  • Close
  • 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.

  • 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.

Defaults to unified.

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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

name
string

The account's name

Supported in
  • Salesforce
description
string

The account's description

Supported in
  • Salesforce
owner
object

The owner of the accounts

Supported in
  • Salesforce
id
string

The owner's unique identifier

industry
string

The account's industry

Supported in
  • Salesforce
website
string

The account's website

Supported in
  • Salesforce
number_of_employees
integer

The account's number of employees

Supported in
  • Salesforce
addresses
object[]
Supported in
  • Salesforce
id
string

The unique identifier of the address

street_1
string

Line 1 of the street address

street_2
string

Line 2 of the street address

city
string

The city

state
string

The state

postal_code
string

The postal code

country
string

The country

type
string

The address type

phone_numbers
object[]
Supported in
  • Salesforce
number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

custom_fields
Supported 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 account's unique identifier

Supported in
  • Close
owner
object

The account's owner

Supported in
  • Close
id
string

The owner's unique identifier

name
string

The account's name

Supported in
  • Close
description
string

The account's description

Supported in
  • Close
industry
string

The account's industry

Supported in
  • Close
website
string

The account's website

Supported in
  • Close
number_of_employees
integer

The account's number of employees

Supported in
  • Close
addresses
object[]
Supported in
  • Close
id
string

The unique identifier of the address

street_1
string

Line 1 of the street address

street_2
string

Line 2 of the street address

city
string

The city

state
string

The state

postal_code
string

The postal code

country
string

The country

type
string

The address type

phone_numbers
object[]
number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

urls
object[]

The candidate's urls

url
string

The candidate's URL

type
string

The candidate's URL type

tags
object[]

The contact's tags

id
string

The tag's unique identifier

name
string

The tag's name

last_activity_at
string · date-time

The date and time of the account's last activity

Supported in
  • Close
updated_at
string · date-time

The date and time of the account's last update

Supported in
  • Close
created_at
string · date-time

The date and time of the account's creation

Supported in
  • Close
remote_data
object

Raw data returned from the remote API call.