Task

patch

https://api.marketcircle.net/v1/tasks/{id}

Edit a task

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See Task for a list of attributes which are supported for tasks. Only attributes marked as Read-Write can be set using this endpoint.

🚧
Repeating tasks cannot be created or modified via the API. Attempting to edit an existing repeating task will return a should_not_edit_task error. To work with repeating tasks, use the Daylite application directly.

📘
Note
When editing a task, including the add or remove actions will allow you to specify a list of items to update/remove from the field's existing contents. Leaving out add or remove will replace the fields contents entirely.
Examples:
{ "keywords": { "add":["test"] } }
{ "contacts": { "remove":[{ "contact": "/v1/contacts/1000" }] } }
For subtasks, see Subtasks.

Ownership

A task's owner is the user responsible for it. See the ownership page for more details.

Response

A successful update returns 204 No Content. Attributes you leave out are not changed. A task in the trash can't be edited (404 with {"error":"trashed_object"}) until you restore it with {"trashed": false}.

Path Params

int32

required

The task ID

Body Params

title

string

Title (max 512 characters).

details

string

Details (max 2048 characters).

category

string

Category name. Created if it does not exist. Send null or "" to clear.

keywords

List of keyword names (max 64). Keywords that do not exist are created. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

due

date-time

Due date, e.g. 2025-03-31T17:00:00.000Z.

location

string

Location (max 2048 characters).

type

string

enum

Task type.

Allowed:

status

string

enum

Task status.

Allowed:

priority

string

enum

Task priority.

Allowed:

started

date-time

When the task was started. Must not be after completed.

completed

date-time

When the task was completed.

estimated_time

integer

Estimated time in seconds.

subtasks

object

References of tasks to make subtasks of this task, e.g. {"add": ["/v1/tasks/2001"]} (max 32 subtasks, nested at most 5 levels deep). To detach a subtask, set that task's parent_task to null.

parent_task

string

Reference of the parent task, e.g. /v1/tasks/1001. Send null to make this a top-level task. If the parent is done, this task is marked done too.

appointments

Appointments linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

contacts

Contacts linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

Companies linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

Opportunities linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

Projects linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

Groups linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

Notes linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

Forms linked to the task. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

email_messages

Emails to link to the task. Write-only: use GET /v1/tasks/{id}/emails to list them. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

owner

string

Reference to the user responsible for the task, e.g. /v1/users/1000. Defaults to the user making the request.

trashed

boolean

Set to false to restore the task from the trash. Use DELETE to move it to the trash.

Responses

204

204 No Content

Note

Ownership

Response

400400 Bad Request

404404 Not Found