Skip to content
POST /unified/crm/fields

Query Parameters

Refer Specifying query parameters in Truto APIs

entitystring

The entity to get the fields for

Possible values:
accountcontactopportunity
2 supported2 required
Capsule
required
Close
required
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

default_valuestring
1 supported
Salesforce
supported
descriptionstring

The field description

6 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
entitystring

The entity to get the fields for

Possible values:
contactaccountopportunitycontactaccountleadopportunitycontactaccountopportunitynotelead+ 13 more
6 supported6 required
Attio
required
contactaccountopportunity
Microsoft Dynamics 365 Sales
required
contactaccountleadopportunity
HubSpot
required
contactaccountopportunitynotelead
Pipedrive
required
contactaccountopportunity
Salesforce
required
contactaccountopportunitynotelead
Zoho CRM
required
contactleadaccountnoteopportunity
field_groupsobject[]
References: FieldGroups → id
1 supported
HubSpot
supported
idstring

The field group's unique identifier

namestring

The field group's name

is_hiddenboolean

Whether the field is hidden

2 supported
Attio
supported
HubSpot
supported
is_requiredboolean

Whether the field is required

5 supported
Attio
supported
Capsule
supported
Microsoft Dynamics 365 Sales
supported
Pipedrive
supported
Salesforce
supported
is_uniqueboolean

Whether the field is unique

4 supported
Attio
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
labelstring

The display label for the field

8 supported8 required
Attio
required
Capsule
required
Close
required
Microsoft Dynamics 365 Sales
required
HubSpot
required
Pipedrive
required
Salesforce
required
Zoho CRM
required
lengthnumber

Maximum length for string fields (default 100)

1 supported
Microsoft Dynamics 365 Sales
supported
namestring

The schema name for the field (without prefix, will be prefixed with 'new_')

7 supported4 required
Attio
required
Microsoft Dynamics 365 Sales
required
HubSpot
required
Salesforce
required
Capsule
supported
Close
supported
Pipedrive
supported
optionsobject[]

Options for enum/array (choice) fields

6 supported
Attio
supported
Capsule
supported
Close
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
descriptionstring

The option's description

is_hiddenboolean

Whether the option is hidden

labelstring

The option's label

valuestring

The option's value

remote_dataRecord<string, any>

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.

typestring

The field type

Possible values:
stringtextrich_textnumberbooleandatedatetimetimeenumarrayfileaddress+ 26 more
8 supported8 required
Attio
required
Capsule
required
Close
required
Microsoft Dynamics 365 Sales
required
stringtextnumberbooleandatedatetimeenumarray
HubSpot
required
Pipedrive
required
stringarraynumberenumdoubledate
Salesforce
required
Zoho CRM
required
stringtextenumarraynumberdatedatetimebooleanemailphoneurlcurrency

Response Body

created_atstring · date-time

The date and time of the field's creation

4 supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
descriptionstring

The field's description

6 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
entity_typestring

The entity type the field belongs to

Possible values:
contactaccountopportunity
6 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
field_groupsobject[]
References: FieldGroups → id
1 supported
HubSpot
supported
idstring

The field group's unique identifier

namestring

The field group's name

idstring

The field's unique identifier

8 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
Zoho CRM
supported
is_editableboolean

Whether the field is editable

6 supported
Attio
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
is_hiddenboolean

Whether the field is hidden

2 supported
Attio
supported
HubSpot
supported
is_requiredboolean

Whether the field is required

5 supported
Attio
supported
Capsule
supported
Microsoft Dynamics 365 Sales
supported
Pipedrive
supported
Salesforce
supported
is_uniqueboolean

Whether the field is unique

4 supported
Attio
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
is_user_definedboolean

Whether the field is user defined

6 supported
Attio
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
labelstring

The field's label

7 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
namestring

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

7 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
optionsobject[]

The field's options

6 supported
Attio
supported
Capsule
supported
Close
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
descriptionstring

The option's description

is_hiddenboolean

Whether the option is hidden

labelstring

The option's label

valuestring

The option's value

reference_entitystring

The entity type this field references to

Possible values:
contactaccountopportunitylead
remote_dataRecord<string, any>

Raw data returned from the remote API call.

typestring

The field's type

Possible values:
stringtextrich_textnumberbooleandatedatetimetimeenumarrayfileaddress
7 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
updated_atstring · date-time

The date and time of the field's last update

4 supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
urlsobject[]

The field's urls

3 supported
Attio
supported
Close
supported
Pipedrive
supported
typestring

The field's URL type

urlstring

The field's URL

curl -X POST 'https://api.truto.one/unified/crm/fields?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "entity": "contact",
  "name": "your_name",
  "label": "your_label",
  "type": "string",
  "description": "your_description",
  "is_required": true,
  "is_unique": true,
  "options": [],
  "length": 0,
  "is_hidden": true,
  "field_groups": [],
  "default_value": "your_default_value",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "entity": "contact",
  "name": "your_name",
  "label": "your_label",
  "type": "string",
  "description": "your_description",
  "is_required": true,
  "is_unique": true,
  "options": [],
  "length": 0,
  "is_hidden": true,
  "field_groups": [],
  "default_value": "your_default_value",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/fields?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/crm/fields"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "entity": "contact",
    "name": "your_name",
    "label": "your_label",
    "type": "string",
    "description": "your_description",
    "is_required": True,
    "is_unique": True,
    "options": [],
    "length": 0,
    "is_hidden": True,
    "field_groups": [],
    "default_value": "your_default_value",
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'crm',
  'fields',
  {
  "entity": "contact",
  "name": "your_name",
  "label": "your_label",
  "type": "string",
  "description": "your_description",
  "is_required": true,
  "is_unique": true,
  "options": [],
  "length": 0,
  "is_hidden": true,
  "field_groups": [],
  "default_value": "your_default_value",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "crm",
        "fields",
        {
        "entity": "contact",
        "name": "your_name",
        "label": "your_label",
        "type": "string",
        "description": "your_description",
        "is_required": True,
        "is_unique": True,
        "options": [],
        "length": 0,
        "is_hidden": True,
        "field_groups": [],
        "default_value": "your_default_value",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())