Appearance

Update Fields ​

Endpoint ​

http
PATCH /unified/crm/fields/{id}
Integrations supported
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • 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
entity
string

The entity to get the fields for

All possible enum values:
  • account
  • contact
  • lead
  • opportunity
Enum support by integration
  • HubSpot
    • contact
    • account
    • opportunity
    • lead
  • Close
    • contact
    • account
    • opportunity
  • Pipedrive
    • contact
    • account
    • opportunity
    • lead
  • Salesforce
    • contact
    • lead
    • account
    • opportunity
  • Capsule
    • contact
    • account
    • opportunity
Required in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce

Request Body ​

Refer Writing data using Unified APIs

label
string

The field's label

Required in
  • HubSpot
Supported in
  • Capsule
  • Salesforce
description
string

The field's description

Supported in
  • Capsule
  • Close
  • HubSpot
type
string

The field's type

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • address
Supported in
  • Close
  • HubSpot
is_hidden
boolean

Whether the field is hidden

Supported in
  • HubSpot
is_unique
boolean

Whether the field is unique

Supported in
  • HubSpot
  • Salesforce
options
object[]

The field's options

Supported in
  • Capsule
  • Close
  • HubSpot
  • Salesforce
label
string

The option's label

value
string

The option's value

description
string

The option's description

is_hidden
boolean

Whether the option is hidden

field_groups
object[]
Supported in
  • HubSpot
id
string

The field group's unique identifier

name
string

The field group's name

name
string

The field's name. This is the name of the property in the entity.

Supported in
  • Close
  • Salesforce
is_required
boolean

Whether the field is required

Supported in
  • Capsule
  • 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

The field's unique identifier

Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
name
string

The field's name. This is the name of the property in the entity.

Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
label
string

The field's label

Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
description
string

The field's description

Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
type
string

The field's type

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • address
Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
is_hidden
boolean

Whether the field is hidden

Supported in
  • HubSpot
is_unique
boolean

Whether the field is unique

Supported in
  • HubSpot
  • Salesforce
is_required
boolean

Whether the field is required

Supported in
  • Capsule
  • Pipedrive
  • Salesforce
is_editable
boolean

Whether the field is editable

Supported in
  • HubSpot
  • Salesforce
options
object[]

The field's options

Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
label
string

The option's label

value
string

The option's value

description
string

The option's description

is_hidden
boolean

Whether the option is hidden

is_user_defined
boolean

Whether the field is user defined

Supported in
  • Close
  • HubSpot
  • Pipedrive
entity_type
string

The entity type the field belongs to

All possible enum values:
  • contact
  • account
  • opportunity
Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
field_groups
object[]
Supported in
  • HubSpot
id
string

The field group's unique identifier

name
string

The field group's name

created_at
string · date-time

The date and time of the field's creation

Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
updated_at
string · date-time

The date and time of the field's last update

Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
remote_data
object

Raw data returned from the remote API call.