Create Fields ​
Endpoint ​
POST /unified/crm/fields
Integrations supported
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
.
unified
raw
normalized
unified
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
The entity to get the fields for
account
activity
contact
lead
opportunity
Enum support by integration
- HubSpot
contact
account
opportunity
lead
- Close
contact
account
opportunity
activity
- Pipedrive
contact
account
opportunity
- Capsule
contact
account
opportunity
Required in
- Capsule
- Close
- HubSpot
- Pipedrive
Supported in
- Salesforce
Request Body ​
Refer Writing data using Unified APIsThe field's name. This is the name of the property in the entity.
Required in
- HubSpot
- Salesforce
The field's label
Required in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
The field's description
Supported in
- Capsule
- Close
- HubSpot
The field's type
string
text
rich_text
number
boolean
date
datetime
time
enum
array
file
Required in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
Whether the field is hidden
Supported in
- HubSpot
Whether the field is unique
Supported in
- HubSpot
- Salesforce
The field's options
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
The option's label
The option's value
The option's description
Whether the option is hidden
Supported in
- HubSpot
The field group's unique identifier
The field group's name
Whether the field is required
Supported in
- Salesforce
Supported in
- Salesforce
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 ​
The field's unique identifier
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
The field's name. This is the name of the property in the entity.
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
The field's label
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
The field's description
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
The field's type
string
text
rich_text
number
boolean
date
datetime
time
enum
array
file
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
Whether the field is hidden
Supported in
- HubSpot
Whether the field is unique
Supported in
- HubSpot
- Salesforce
Whether the field is required
Supported in
- Pipedrive
- Salesforce
Whether the field is editable
Supported in
- HubSpot
- Salesforce
The field's options
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
The option's label
The option's value
The option's description
Whether the option is hidden
Whether the field is user defined
Supported in
- Close
- HubSpot
- Pipedrive
The entity type the field belongs to
contact
account
opportunity
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
Supported in
- HubSpot
The field group's unique identifier
The field group's name
The date and time of the field's creation
Supported in
- Close
- HubSpot
- Pipedrive
- Salesforce
The date and time of the field's last update
Supported in
- Close
- HubSpot
- Pipedrive
- Salesforce
Raw data returned from the remote API call.