Tasks

Update a task

Updates the given fields. A task of an archived event is read-only (409). Role permission: data.write.

patch/tasks/{id}

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/tasks/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.write)

Headers

Idempotency-Keystring

Optional client-generated key (1 to 255 characters, e.g. a UUID v4) that makes the request idempotent for 24 hours: a retry with the same key replays the recorded response (marked Idempotency-Replayed: true) instead of executing the operation again. Same key with another body: 422 idempotency_key_reuse; while the first request runs: 409 idempotency_conflict. See the Idempotency section.

Request body

titlestring
status'todo' | 'in_progress' | 'waiting' | 'done' | 'cancelled'
priority'low' | 'medium' | 'high' | 'urgent'
due_datestring date-time
assigned_to_account_idstring uuid
event_idstring uuid

Response

The updated task.

idstring uuid
task_numberinteger nullable
titlestring
status'todo' | 'in_progress' | 'waiting' | 'done' | 'cancelled'
priority'low' | 'medium' | 'high' | 'urgent'
due_datestring date-time nullable
start_datestring date-time nullable
estimated_duration_minutesinteger nullable
event_idstring uuid nullable
brief_idstring uuid nullable
company_idstring uuid nullable
contact_person_idstring uuid nullable
location_idstring uuid nullable
assigned_to_account_idstring uuid nullable

The member the task is assigned to.

categorystring nullable
created_atstring date-time nullable
updated_atstring date-time nullable
account_idstring uuid nullable
descriptionstring nullable
notesstring nullable
quote_idstring uuid nullable
attachmentsstring[] nullable
dependenciesstring[] nullable
cancelled_reasonstring nullable
status_before_cancellationstring nullable
is_demoboolean

Example response

{
  "title": "Send the signed contract"
}

Changes

No recorded changes to this operation across all 1 revision of this API.