Create a task
Creates a new task.
At present, tasks can only be created from plaintext without record reference formatting.
Required scopes: task:read-write, object_configuration:read, record_permission:read, user_management:read.
curl --request POST \
--url https://api.attio.com/v2/tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"content": "Follow up on current software solutions",
"format": "plaintext",
"deadline_at": "2023-01-01T15:00:00.000000000Z",
"is_completed": false,
"linked_records": [
{
"target_object": "people",
"target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
}
],
"assignees": [
{
"referenced_actor_type": "workspace-member",
"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
]
}
}'{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"task_id": "649e34f4-c39a-4f4d-99ef-48a36bef8f04"
},
"content_plaintext": "Follow up on current software solutions",
"deadline_at": "2023-01-01",
"is_completed": false,
"linked_records": [
{
"target_object_id": "people",
"target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
}
],
"assignees": [
{
"referenced_actor_type": "workspace-member",
"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
],
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
}Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Body
The text content of the task, in the format specified by the format property.
"Follow up on current software solutions"
The format of the task content to be created. Rich text formatting, links and @references are not supported.
plaintext The deadline of the task, in ISO 8601 format.
"2023-01-01T15:00:00.000000000Z"
Whether the task has been completed.
false
Records linked to the task. Creating record links within task content text is not possible via the API at present.
The ID or slug of the parent object the tasks refers to. This can reference both standard and custom objects.`
"people"
The ID of the parent record the task refers to.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
Workspace members assigned to this task.
The actor type of the task assignee. Only workspace-member actors can be assigned to tasks. Read more information on actor types here.
workspace-member "workspace-member"
The ID of the actor assigned to this task.
"50cf242c-7fa3-4cad-87d0-75b1af71c57b"
Response
Success
The plaintext representation of the task content. Inline linked records will appear as "@record name" and are returned in the linked_records property.
"Follow up on current software solutions"
The deadline date of the task. Returned as an ISO 8601 timestamp.
"2023-01-01"
Whether the task has been completed.
false
Records linked to the task. Creating record links within task content text is not possible via the API at present.
The ID of the parent object the task refers to. At present, only people and companies are supported.
"people"
The ID of the parent record the task refers to.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
Workspace members assigned to this task.
The type of actor. Read more information on actor types here.
api-token, workspace-member, system, app "workspace-member"
The ID of the workspace member actor assigned to this task.
"50cf242c-7fa3-4cad-87d0-75b1af71c57b"
The actor that created this task.
An ID to identify the actor.
The type of actor. Read more information on actor types here.
api-token, workspace-member, system, app {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
When the task was created.
"2022-11-21T13:22:49.061281000Z"
Was this page helpful?
curl --request POST \
--url https://api.attio.com/v2/tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"content": "Follow up on current software solutions",
"format": "plaintext",
"deadline_at": "2023-01-01T15:00:00.000000000Z",
"is_completed": false,
"linked_records": [
{
"target_object": "people",
"target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
}
],
"assignees": [
{
"referenced_actor_type": "workspace-member",
"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
]
}
}'{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"task_id": "649e34f4-c39a-4f4d-99ef-48a36bef8f04"
},
"content_plaintext": "Follow up on current software solutions",
"deadline_at": "2023-01-01",
"is_completed": false,
"linked_records": [
{
"target_object_id": "people",
"target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
}
],
"assignees": [
{
"referenced_actor_type": "workspace-member",
"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
],
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
}