Templates and tasks for records
Create a task from a saved template or one task for each selected record.
Create a task from a template
POST /v1/task-management/from-template
Creates a task from one of the templates in the task configuration, which lists each template with its version, linked to the records you send. The template's values, defaults and due date apply, and its title and description fill in the values they insert from the linked records. start_date is the day its dates count from; today when left out. Poll the returned operation to follow the task to Attio. Works only for an API key given Better tasks access in Settings, Integrations & MCP.
Requires tasks:create. The connection also needs access to the relevant tables, objects, or workflows.
MCP action: create_task_from_template. Its arguments use the names below, except fields marked REST only. An HTTP header is passed using its argument name in MCP.
Parameters
| Name | Send in | Required | Type or allowed values | Notes |
|---|---|---|---|---|
template_id |
JSON body | Yes | string (uuid) | |
template_version |
JSON body | Yes | integer | |
start_date |
JSON body | No | string (date) | |
linked_records |
JSON body | No | array of object | |
linked_records[].object_id |
Within the JSON value | Within this object | string (uuid) | |
linked_records[].record_id |
Within the JSON value | Within this object | string (uuid) | |
request_key |
Header: Idempotency-Key |
Yes | string |
Response
| HTTP status | Result |
|---|---|
202 |
The task is saved and on its way to Attio. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
OperationReceipt | Yes | |
data.id |
string | Yes | |
data.object |
"operation" |
Yes | |
data.version |
string | Yes | |
data.resource_id |
string | Yes | |
data.resource_type |
string | Yes | |
data.status |
"pending", "succeeded", "failed", "canceled", "needs_attention" |
Yes | |
data.terminal |
boolean | Yes | |
data.created_at |
string (date-time) | Yes | |
data.ended_at |
string (date-time) or null | Yes | |
data.reason_code |
string or null | Yes | |
data.replayed |
true |
No | |
data.operation_type |
"scan_cancel", "ai_assessment", "ai_assessment_cancel", "review_update", "exclusion_create", "exclusion_update", "scheduled_batch_create", "scheduled_batch_update", "scheduled_batch_cancel", "scheduled_run_cancel", "scheduled_record_cancel", "schedule_create", "schedule_update", "webhook_endpoint_create", "webhook_endpoint_update", "webhook_secret_rotate", "endpoint_verification", "webhook_replay", "task_create", "task_update", "task_archive", "task_comment_create", "merge_rebuild", "scheduled_batch_transfer", "webhook_endpoint_transfer", "task_import" |
Yes | When data.operation_type is "scan_cancel", "ai_assessment", "ai_assessment_cancel", "review_update", "exclusion_create", "exclusion_update", "scheduled_batch_create", "scheduled_batch_update", "scheduled_batch_cancel", "scheduled_run_cancel", "scheduled_record_cancel", "schedule_create", "schedule_update", "webhook_endpoint_create", "webhook_endpoint_update", "webhook_secret_rotate", "endpoint_verification", "webhook_replay", "task_create", "task_update", "task_archive", "task_comment_create", "merge_rebuild", "scheduled_batch_transfer", "webhook_endpoint_transfer", "task_import". |
data.action_metadata |
object | Yes | |
data.action_metadata.resource_version |
string | Yes | |
data.action_metadata.allowed_actions |
array of string | Yes | |
data.operation_type |
"merge_execute", "merge_cancel" |
Yes | When data.operation_type is "merge_execute", "merge_cancel". |
data.action_metadata.execute_not_before |
string (date-time) | Yes | When data.operation_type is "merge_execute", "merge_cancel". |
data.action_metadata.authorization_expires_at |
string (date-time) | Yes | When data.operation_type is "merge_execute", "merge_cancel". |
data.operation_type |
"plan_prepare", "plan_revision_prepare", "retry_plan_prepare" |
Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.plan_revision |
string | Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.effects_digest |
string or null | Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.preview_digest |
string or null | Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.recovery_coverage_digest |
string or null | Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.authorization_requirement |
object | Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.authorization_requirement.scope |
"organization_baseline" |
Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.authorization_requirement.mode |
"api_key_allowed", "not_allowed" |
Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.authorization_requirement.policy_version |
string | Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.authorization_requirement.grant_evaluation |
"at_execution" |
Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.authorization_requirement.reason_code |
string or null | Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.action_metadata.authorization_state |
"unauthorized", "authorized", "rejected", "invalidated", "expired" |
Yes | When data.operation_type is "plan_prepare", "plan_revision_prepare", "retry_plan_prepare". |
data.operation_type |
"review_bulk_update", "exclusion_bulk_create" |
Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results |
array of object | Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].index |
integer | Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].outcome |
"succeeded", "failed" |
Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].resource_ref |
object | No | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].resource_ref.id |
string | Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].resource_ref.version |
string | Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].error |
object | No | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].error.code |
string | Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].error.message |
string | Yes | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.action_metadata.results[].error.param |
string | No | When data.operation_type is "review_bulk_update", "exclusion_bulk_create". |
data.operation_type |
"scan", "scan_continue" |
Yes | When data.operation_type is "scan", "scan_continue". |
data.action_metadata.ai_child |
object | Yes | When data.operation_type is "scan", "scan_continue". |
data.action_metadata.ai_child.state |
"not_requested", "pending_admission", "admitted", "skipped", "failed" |
Yes | When data.operation_type is "scan", "scan_continue". |
data.action_metadata.ai_child.reason_code |
string or null | Yes | When data.operation_type is "scan", "scan_continue". |
data.action_metadata.ai_child.ai_run_id |
string | No | When data.operation_type is "scan", "scan_continue". |
data.action_metadata.ai_child.ai_operation_id |
string | No | When data.operation_type is "scan", "scan_continue". |
data.action_metadata.ai_child.operation_url |
string (uri) | No | When data.operation_type is "scan", "scan_continue". |
data.operation_type |
"brevo_list_add" |
Yes | When data.operation_type is "brevo_list_add". |
data.action_metadata.list_id |
integer | Yes | When data.operation_type is "brevo_list_add". |
data.action_metadata.records |
array of object | Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". When data.operation_type is value. When data.operation_type is value. When data.operation_type is value. |
data.action_metadata.records[].record_id |
string | Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". When data.operation_type is value. When data.operation_type is value. When data.operation_type is value. |
data.action_metadata.records[].outcome |
"pending", "added", "skipped", "unconfirmed", "failed" |
Yes | When data.operation_type is "brevo_list_add". When data.operation_type is value. |
data.action_metadata.records[].reason |
"restricted", "identity_hold", "monitoring_not_current", "no_email", "no_contact", "excluded", "changed", "confirming", "record_not_found" or null |
Yes | When data.operation_type is "brevo_list_add". |
data.action_metadata.records[].addresses |
array of object | Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". |
data.action_metadata.records[].addresses[].source |
"profile" or object |
Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". |
data.action_metadata.records[].addresses[].source.attribute |
"email_addresses" |
Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". Alternative 2. |
data.action_metadata.records[].addresses[].source.position |
integer | Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". Alternative 2. |
data.action_metadata.records[].addresses[].outcome |
"used", "skipped" |
Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". |
data.action_metadata.records[].addresses[].reason |
"restricted" or null |
Yes | When data.operation_type is "brevo_list_add". When data.operation_type is "brevo_email_send". |
data.operation_type |
"brevo_email_send" |
Yes | When data.operation_type is "brevo_email_send". |
data.action_metadata.template_id |
integer | Yes | When data.operation_type is "brevo_email_send". |
data.action_metadata.records[].outcome |
"pending", "sent", "skipped", "unconfirmed", "failed" |
Yes | When data.operation_type is "brevo_email_send". When data.operation_type is value. |
data.action_metadata.records[].reason |
"restricted", "identity_hold", "monitoring_not_current", "no_email", "excluded", "recently_sent", "changed", "confirming", "record_not_found" or null |
Yes | When data.operation_type is "brevo_email_send". |
data.operation_type |
value | Yes | When data.operation_type is value. When data.operation_type is value. When data.operation_type is value. When data.operation_type is value. |
data.action_metadata.list_id |
string | Yes | When data.operation_type is value. When data.operation_type is value. |
data.action_metadata.records[].reason |
"restricted", "identity_hold", "monitoring_not_current", "no_contact", "excluded", "changed", "record_not_found" or null |
Yes | When data.operation_type is value. |
data.action_metadata.records[].outcome |
"pending", "removed", "skipped", "unconfirmed", "failed" |
Yes | When data.operation_type is value. |
data.action_metadata.records[].reason |
"not_in_list", "identity_hold", "no_contact", "changed", "record_not_found" or null |
Yes | When data.operation_type is value. |
data.action_metadata.outcome |
"pending", "unsubscribed", "unconfirmed", "failed", "skipped" |
Yes | When data.operation_type is value. |
data.action_metadata.reason |
"no_contact", "changed" or null |
Yes | When data.operation_type is value. |
data.action_metadata.metric |
string | Yes | When data.operation_type is value. |
data.action_metadata.properties |
object | Yes | When data.operation_type is value. |
data.action_metadata.properties.{key} |
string or number or boolean or null | No | When data.operation_type is value. Value for each key in this object. |
data.action_metadata.records[].reason |
"restricted", "identity_hold", "monitoring_not_current", "no_contact", "excluded", "recently_sent", "changed", "record_not_found" or null |
Yes | When data.operation_type is value. |
Accepted work can continue after the request returns. Follow its returned status or operation until it finishes; accepting work does not mean every item succeeded. See operation status.
Errors
| HTTP status | Meaning |
|---|---|
400 |
One of: credential_in_url, invalid_parameter, invalid_request, unknown_parameter. |
401 |
One of: missing_credential, invalid_credential, credential_expired, credential_revoked. |
402 |
One of: payment_overdue. |
403 |
One of: scope_required, plan_required, not_available, resource_forbidden. |
404 |
One of: not_found. |
409 |
One of: idempotency_conflict, setup_required, version_conflict. |
410 |
One of: resource_expired. |
413 |
One of: request_too_large. |
422 |
One of: invalid_selection, budget_exceeded. |
423 |
One of: organization_reopening. |
428 |
One of: customer_agreement_required. |
429 |
One of: rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
Create a task for each record
POST /v1/task-management/for-records
Creates one task for each record you send, each linked to its own record. Send the task's values as task, or a template as template, not both. Each record's result is its own: a record that can't get a task says why, and the others are still created. Choose a new submission_id for each new set of tasks; sending the same submission_id again creates only the tasks still missing and names the ones already created. Works only for an API key given Better tasks access in Settings, Integrations & MCP.
Requires tasks:create. The connection also needs access to the relevant tables, objects, or workflows.
MCP action: create_tasks_for_records. Its arguments use the names below, except fields marked REST only. An HTTP header is passed using its argument name in MCP.
Parameters
| Name | Send in | Required | Type or allowed values | Notes |
|---|---|---|---|---|
submission_id |
JSON body | Yes | string (uuid) | |
records |
JSON body | Yes | array of object | |
records[].object_id |
Within the JSON value | Within this object | string (uuid) | |
records[].record_id |
Within the JSON value | Within this object | string (uuid) | |
task |
JSON body | No | object | |
task.title |
Within the JSON value | Within this object | string | |
task.description |
Within the JSON value | No | string | |
task.type_id |
Within the JSON value | No | string (uuid) | |
task.status_id |
Within the JSON value | No | string | |
task.priority |
Within the JSON value | No | "Low", "Normal", "High", "Urgent" |
|
task.owner_id |
Within the JSON value | No | string (uuid) or null | |
task.assignee_ids |
Within the JSON value | No | array of string (uuid) | |
task.due_at |
Within the JSON value | No | string (date-time) or null | |
task.due_type |
Within the JSON value | No | "Target", "Deadline" |
|
task.parent_task_id |
Within the JSON value | No | string (uuid) or null | |
task.attributes |
Within the JSON value | No | object | |
task.attributes.{key} |
Within the JSON value | No | string or array of string | Value for each key in this object. |
task.checklist |
Within the JSON value | No | array of object | |
task.checklist[].id |
Within the JSON value | Within this object | string (uuid) | |
task.checklist[].title |
Within the JSON value | Within this object | string | |
task.checklist[].done |
Within the JSON value | Within this object | boolean | |
task.file_links |
Within the JSON value | No | array of object | |
task.file_links[].id |
Within the JSON value | Within this object | string (uuid) | |
task.file_links[].name |
Within the JSON value | Within this object | string | |
task.file_links[].url |
Within the JSON value | Within this object | string (uri) | |
task.recurrence |
Within the JSON value | No | object or null | |
task.recurrence.every |
Within the JSON value | Within this object | integer | Alternative 1. |
task.recurrence.unit |
Within the JSON value | Within this object | "days", "weeks", "months", "years" |
Alternative 1. |
task.recurrence.basis |
Within the JSON value | Within this object | "schedule", "completion" |
Alternative 1. |
template |
JSON body | No | object | |
template.template_id |
Within the JSON value | Within this object | string (uuid) | |
template.template_version |
Within the JSON value | Within this object | integer | |
template.start_date |
Within the JSON value | No | string (date) | |
confirmed |
JSON body | No | true |
No longer needed. Accepted and ignored. |
request_key |
Header: Idempotency-Key |
Yes | string |
Response
| HTTP status | Result |
|---|---|
200 |
Each record's task, or why it has none. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
object | Yes | |
data.object |
"task_record_batch" |
Yes | |
data.submission_id |
string (uuid) | Yes | |
data.results |
array of object | Yes | |
data.results[].object_id |
string (uuid) | Yes | |
data.results[].record_id |
string (uuid) | Yes | |
data.results[].task_id |
string (uuid) or null | Yes | |
data.results[].error |
"invalid_values", "changed", "not_found", "setup_required", "unavailable", "allowance_used" or null |
Yes | |
references |
array of object | Yes | |
references[].provider |
"attio" |
Yes | |
references[].workspace_id |
string or null | Yes | |
references[].object_id |
string or null | Yes | |
references[].object_slug |
string or null | Yes | |
references[].records |
array of object | Yes | |
references[].records[].record_id |
string | Yes | |
references[].records[].web_url |
string (uri) or null | Yes | |
references[].records[].attributes |
array of object | Yes | |
references[].records[].attributes[].attribute_id |
string or null | Yes | |
references[].records[].attributes[].attribute_slug |
string or null | Yes | |
references[].records[].via |
array of object | Yes | |
references[].records[].via[].source_object_id |
string or null | Yes | |
references[].records[].via[].source_object_slug |
string or null | Yes | |
references[].records[].via[].source_record_id |
string | Yes | |
references[].records[].via[].attribute_id |
string or null | Yes | |
references[].records[].via[].attribute_slug |
string or null | Yes | |
references[].records[].via[].target_object_id |
string or null | Yes | |
references[].records[].via[].target_object_slug |
string or null | Yes | |
references[].records[].via[].target_record_id |
string | Yes | |
references[].lookup_hint |
object | Yes | |
references[].lookup_hint.resource |
"records" |
Yes | |
references[].lookup_hint.object |
string | Yes | |
references[].lookup_hint.record_ids |
array of string | Yes |
Errors
| HTTP status | Meaning |
|---|---|
400 |
One of: credential_in_url, invalid_parameter, invalid_request, unknown_parameter. |
401 |
One of: missing_credential, invalid_credential, credential_expired, credential_revoked. |
402 |
One of: payment_overdue. |
403 |
One of: scope_required, plan_required, not_available, resource_forbidden. |
404 |
One of: not_found. |
409 |
One of: idempotency_conflict, setup_required, version_conflict. |
410 |
One of: resource_expired. |
413 |
One of: request_too_large. |
422 |
One of: invalid_selection. |
423 |
One of: organization_reopening. |
428 |
One of: customer_agreement_required. |
429 |
One of: rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
The public OpenAPI document lists generally available API families. Alpha operations may not appear in that document; their request and response fields are listed on this page. Use the API Playground to inspect a real response with your connection's access.