PAparley
Tasks

Update a task

Rename a task, change its status, assignee, due date, description, or the record it's about, set its field values, or set or remove the caller's reminder for it. Omitted properties are left unchanged. Anyone who can see a task can set their own reminder on it.

patch/tasks/{id}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/tasks/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The task ID.

Request body

titlestring

Task title.

status'todo' | 'in_progress' | 'done' | 'cancelled'

Where the task stands: todo, in_progress, done, or cancelled. done and cancelled close it.

assigneeIdstring nullable

The ID of an active user in the organization to assign it to, or null to unassign it.

dueDatestring date nullable

The day the task is due, as YYYY-MM-DD.

descriptionstring nullable

Details, up to 2,000 characters.

fieldsobject

Custom field values to set on the task, keyed by field name or ID. A value replaces the current one, null clears it, and fields you don't mention are left alone. Each value must match its field's type: a string for text, long_text, email, url, single_select (one of the field's options), and user (the id of an active user in the organization); a number; true or false; an ISO 8601 date-time or YYYY-MM-DD date; a list of strings for collection ([] clears it); or { streetAddress, cityTown, state, country } for address. At most 50 fields. Status, assignee, due date, and description are properties of the task, not fields.

Response

OK

idstring required

The task ID.

titlestring required

Task title.

status'todo' | 'in_progress' | 'done' | 'cancelled' nullable required

Where the task stands: todo, in_progress, done, or cancelled. done and cancelled close it.

dueDatestring date nullable required

The day the task is due, as YYYY-MM-DD.

descriptionstring nullable required

Details, or null.

createdAtstring date-time required

When the task was created.

updatedAtstring date-time required

When the task was last renamed or linked to a different record. Changes to its status, assignee, due date, description, field values, and reminders do not change it.

fieldsobject required

Custom field values, keyed by field name, with a key for every field defined for tasks (null when unset). The value's shape follows the field's type. Status, assignee, due date, and description are properties of the task, not fields.

Changes

No recorded changes to this operation across all 2 revisions of this API.