Update record
update_recordPatch object_type + id; returns the fresh record. Built-ins use typed domain logic; custom data is shallow-merged. Update an existing View with report + patch:{definition}; create a View only for a different perspective. Activity patches correct subject/summary/time/type. Sequence plans save together with saved step ids, revisions and an identical-retry request_id; enrollment fences timing/channel/order changes. Maintenance fields each run alone: task subtasks replaces the checklist; contact engaged:true is a ratchet; opportunity board_rank orders its column; sequence_step position swaps neighbours, fenced while people are partway through. See patch for syntax; task due follows create_record.
When to use: Edit fields (stage, task status:'done'). Retire converted leads LAST: status:'converted', account/contact/opportunity ids, converted_at, deleted_at; see an MCP resource at capable://guide/leads.
Example: Update opportunity : set stage to verbal.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"object_type": "<object_type>",
"id": "<id>",
"patch": "<patch>"
},
"name": "update_record"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A uuid. | |
| patch | Yes | Changed fields only, key → value; at least one required. Null clears custom data or a built-in custom_fields key; custom data is shallow-merged. Sequence: steps (keep saved ids), expected_revision (sequence mcp_revision), expected_steps:[{id,revision}] for every live step, request_id UUID reused only for an identical retry. Maintenance, each alone: task subtasks:[{id?,title,done?}] replaces the entire checklist; contact engaged:true; opportunity board_rank:{before?,after?}; sequence_step position swaps with the neighbour occupying that slot. | |
| object_type | Yes | Object key of the record being patched, e.g. account, contact, task, report, a custom object's key, or rollup / automation / field (admin-only; the id from describe_schema); an unknown key returns the valid types and writes nothing. | |
| expected_revision | No | Optional record revision from a reviewed update, as the text a review sealed or the number a record read shows in mcp_revision; a changed record is refused without writing. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| record | No | ||
| result | No | ||
| updated | No | ||
| object_type | No | ||
| custom_field_definitions | No |