Appearance

Create Fields ​

Endpoint ​

http
POST /unified/crm/fields
Integrations supported
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
entity
string
The entity to get the fields for
All possible enum values:
  • account
  • activity
  • contact
  • lead
  • opportunity
Enum support by integration
  • HubSpot
    • contact
    • account
    • opportunity
  • Close
    • contact
    • account
    • opportunity
    • activity
  • Pipedrive
    • contact
    • account
    • opportunity
  • Salesforce
    • contact
    • lead
    • account
    • opportunity
  • Capsule
    • contact
    • account
    • opportunity
Required in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce

Request Body ​

Refer Writing data using Unified APIs

name
string
The field's name. This is the name of the property in the entity.
Required in
  • HubSpot
  • Salesforce
label
string
The field's label
Required in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • 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
Required 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
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_required
boolean
Whether the field is required
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
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
  • Salesforce
type
string
The field's type
All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
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
  • Pipedrive
  • 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
  • HubSpot
entity_type
string
The entity type the field belongs to
All possible enum values:
  • contact
  • account
  • opportunity
Supported in
  • Capsule
  • Close
  • HubSpot
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.