update_transaction_custom_task
Update transaction checklist task
Rename, complete, or reopen one buyer-created checklist item. A task from a stage the transaction has already passed stays editable (a walkthrough item written under contract is completed after the close); only a task filed ahead of the current stage waits. To complete a task, pass taskId and completed without a title; a title is at most 180 characters. Reuse mutationId for an exact retry. Completion records checklist state only and does not prove an external, legal, financial, document, or communication action occurred.
- Effect
- Draft or workspace edit
- Required scopes
workspace:write- Workflow stages
- closing, transaction
- Data classes
- deadlines tasks, transaction
- Operation cost
- 2 weighted units; additional domain limits may apply.
- Configurations
- Standard, Buyer UI v2
- Muse proposal
- Write. Creates or updates draft, document, or workspace data within the authorized workflow. Meta makes the final classification during review.
Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.
Input and output contracts
Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.
Input fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints |
|---|---|---|
expectedCustomTasksRevisionstring | No | Pattern validation applies; see the raw schema. |
mutationIdstring | Yes | A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label. Format: uuid. Pattern validation applies; see the raw schema. |
workspaceIdstring | Yes | Pattern validation applies; see the raw schema. |
completedboolean | No | No additional description in the contract. |
taskIdstring | Yes | Pattern validation applies; see the raw schema. |
titlestring | No | Minimum characters: 1. Maximum characters: 180. |
Output fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customTaskobject | Yes | Extra fields are not allowed. | |||||||||||||||||||||
customTask: nested contract
| |||||||||||||||||||||||
customTasksarray<object> | Yes | Maximum items: 50. | |||||||||||||||||||||
customTasks: nested contractArray item contractExtra fields are not allowed.
| |||||||||||||||||||||||
customTasksRevisionstring | Yes | Pattern validation applies; see the raw schema. | |||||||||||||||||||||
mutationIdstring | Yes | A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label. Format: uuid. Pattern validation applies; see the raw schema. | |||||||||||||||||||||
schemaVersionstring | Yes | Must be "1". | |||||||||||||||||||||
workspaceIdstring | Yes | Pattern validation applies; see the raw schema. | |||||||||||||||||||||
Raw input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"expectedCustomTasksRevision": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
"mutationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label."
},
"workspaceId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
},
"completed": {
"type": "boolean"
},
"taskId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 180
}
},
"required": [
"mutationId",
"workspaceId",
"taskId"
],
"additionalProperties": false
}Full output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customTask": {
"type": "object",
"properties": {
"completed": {
"type": "boolean"
},
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
},
"phaseId": {
"type": "string",
"enum": [
"signed",
"sent",
"negotiating",
"under-contract",
"post-purchase"
]
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 180
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"completed",
"id",
"phaseId",
"title",
"updatedAt"
],
"additionalProperties": false
},
"customTasks": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"completed": {
"type": "boolean"
},
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
},
"phaseId": {
"type": "string",
"enum": [
"signed",
"sent",
"negotiating",
"under-contract",
"post-purchase"
]
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 180
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"completed",
"id",
"phaseId",
"title",
"updatedAt"
],
"additionalProperties": false
}
},
"customTasksRevision": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
"mutationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label."
},
"schemaVersion": {
"type": "string",
"const": "1"
},
"workspaceId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
}
},
"required": [
"customTask",
"customTasks",
"customTasksRevision",
"mutationId",
"schemaVersion",
"workspaceId"
],
"additionalProperties": false
}Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": false
}Reference 00e5441a095c7e20. Download the full catalog.