Update Fields
/unified/crm/fields/{id}
Path Parameters
The ID of the resource.
23423523Query Parameters
Refer Specifying query parameters in Truto APIs
The entity to get the fields for
accountcontactopportunity
2 supported2 required
Optional Salesforce field length for text and rich_text fields. If omitted on update, the existing Salesforce length is preserved when available; otherwise 8192 is used. Valid Salesforce range is 256 to 131072 characters.
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount).debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
The field's new description
6 supported
The entity to get the fields for
contactaccountopportunitycontactaccountleadopportunitycontactaccountopportunitynoteleadcontactaccountopportunitycontactaccountopportunitynoteleadcontactleadaccountnoteopportunity+ 13 more
6 supported6 required
contactaccountopportunitycontactaccountleadopportunitycontactaccountopportunitynoteleadcontactaccountopportunitycontactaccountopportunitynoteleadcontactleadaccountnoteopportunityThe entity type the field belongs to
contactaccountopportunitycontactaccountopportunity
7 supported
contactaccountopportunity1 supported
The field group's unique identifier
The field group's name
Whether the field is editable
6 supported
Whether the field is hidden
2 supported
Update requirement level
5 supported
Whether the field is unique
4 supported
Whether the field is user defined
7 supported
The field's new label
8 supported
The field's name. This is the name of the property in the entity.
8 supported1 required
Options to add or rename on the OptionSet. Existing options not mentioned are preserved (additive merge). For a new option, omit value. To rename an existing option, set value to its current numeric OptionSet integer as a string (e.g. "100000001"). Do not send a non-numeric string as value — Dynamics OptionSet values are integers assigned by Dataverse.
7 supported
The option's description
Whether the option is hidden
The option's label
The option's value
The entity type this field references to
contactaccountopportunityleadcontactaccountopportunitylead
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.
The field's type
stringtextrich_textnumberbooleandatedatetimetimeenumarrayfileaddressstringtextnumberbooleandatedatetimeenumarraystringtextrich_textnumberbooleandatedatetimetimeenumarrayfileaddress+ 20 more
8 supported3 required
stringtextnumberbooleandatedatetimeenumarraystringtextrich_textnumberbooleandatedatetimetimeenumarrayfileaddressMake field unique with case_sensitive setting
1 supported
The field's urls
3 supported
The field's URL type
The field's URL
Response Body
The date and time of the field's creation
4 supported
The field's description
6 supported
The entity type the field belongs to
contactaccountopportunity
7 supported
1 supported
The field group's unique identifier
The field group's name
The field's unique identifier
9 supported
Whether the field is editable
6 supported
Whether the field is hidden
2 supported
Whether the field is required
5 supported
Whether the field is unique
4 supported
Whether the field is user defined
7 supported
The field's label
8 supported
The field's name. This is the name of the property in the entity.
8 supported
The field's options
7 supported
The option's description
Whether the option is hidden
The option's label
The option's value
The entity type this field references to
contactaccountopportunitylead
Raw data returned from the remote API call.
The field's type
stringtextrich_textnumberbooleandatedatetimetimeenumarrayfileaddress
8 supported
The date and time of the field's last update
4 supported
The field's urls
3 supported
The field's URL type
The field's URL
truto unified crm fields '<resource_id>' \
-m update \
-a '<integrated_account_id>' \
-b '{
"entity": "contact",
"name": "your_name",
"label": "your_label",
"type": "string",
"description": "your_description",
"is_required": true,
"is_unique": true,
"options": [],
"is_hidden": true,
"is_editable": true,
"is_user_defined": true,
"entity_type": "contact",
"reference_entity": "contact",
"field_groups": [],
"urls": [],
"unique": {},
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.update(
'crm',
'fields',
'<resource_id>',
{
"entity": "contact",
"name": "your_name",
"label": "your_label",
"type": "string",
"description": "your_description",
"is_required": true,
"is_unique": true,
"options": [],
"is_hidden": true,
"is_editable": true,
"is_user_defined": true,
"entity_type": "contact",
"reference_entity": "contact",
"field_groups": [],
"urls": [],
"unique": {},
"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.update(
"crm",
"fields",
"<resource_id>",
{
"entity": "contact",
"name": "your_name",
"label": "your_label",
"type": "string",
"description": "your_description",
"is_required": True,
"is_unique": True,
"options": [],
"is_hidden": True,
"is_editable": True,
"is_user_defined": True,
"entity_type": "contact",
"reference_entity": "contact",
"field_groups": [],
"urls": [],
"unique": {},
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X PATCH 'https://api.truto.one/unified/crm/fields/{id}?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": [],
"is_hidden": true,
"is_editable": true,
"is_user_defined": true,
"entity_type": "contact",
"reference_entity": "contact",
"field_groups": [],
"urls": [],
"unique": {},
"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": [],
"is_hidden": true,
"is_editable": true,
"is_user_defined": true,
"entity_type": "contact",
"reference_entity": "contact",
"field_groups": [],
"urls": [],
"unique": {},
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/crm/fields/{id}?integrated_account_id=${integratedAccountId}`, {
method: 'PATCH',
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/{id}"
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": [],
"is_hidden": True,
"is_editable": True,
"is_user_defined": True,
"entity_type": "contact",
"reference_entity": "contact",
"field_groups": [],
"urls": [],
"unique": {},
"remote_data": {}
}
response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())