SLslant
Tasks

Update a task

Changed on

Update an existing task

patch/v1/tasks/{id}

Request

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

Path parameters

idstring required

The task ID

Headers

Idempotency-Keystring

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Request body

titlestring

Task title; must not be blank

descriptionstring

Task description

deadline_atstring date-time nullable

Deadline for the task; send null to clear it

all_dayboolean

Whether this is an all-day task

status'todo' | 'done'

Task status

priority'low_priority' | 'medium_priority' | 'high_priority' | 'urgent_priority'

Task priority

is_privateboolean

When true, only the creator, assignee (or members of the assigned team), and collaborators can see this task.

household_idstring

Associate task with a household

contact_idstring

Associate task with a contact

business_idstring

Associate task with a business

assigned_to_idstring

User ID from the relevant book users list to assign the task to

assigned_team_idstring

Team ID to assign the task to (mutually exclusive with assigned_to_id)

tag_idsstring[]

Label IDs to replace the task labels with

Example request

{
  "title": "Updated task title"
}

Response

task updated

idstring required

The task ID

titlestring required

Task title

descriptionstring nullable

Task description

deadline_atstring date-time nullable

Deadline for the task

all_dayboolean required

Whether this is an all-day task

status'todo' | 'done' required

Task status

priority'low_priority' | 'medium_priority' | 'high_priority' | 'urgent_priority' nullable

Task priority

is_privateboolean

When true, only the creator, assignee (or members of the assigned team), and collaborators can see this task. Use for sensitive tasks like HR or payroll.

completed_atstring date-time nullable

When the task was completed

created_atstring date-time required

When the task was created

updated_atstring date-time required

When the task was last updated

book_idstring

The book ID

Example response

{
  "id": "abc123xyz",
  "title": "Follow up with client"
}

Changes

  • 173c41bf6be9Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • info

      the request property became nullable

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the invalid_json enum value from the response property for the response status

    • info

      response property detail list-of-types was narrowed by removing types array from media type application/json of response 400