ZEzenzap
Tasks

Update a task

Update task fields. This endpoint supports partial updates.

Updatable fields:

  • name (alias of title)
  • description
  • assignee
  • dueDate
  • status (Open or Done)

Notes:

  • Provide either name or title (not both)
  • Setting assignee to an empty string unassigns the task
  • Setting dueDate to 0 clears the due date
  • When status is set to Done, the task is marked as closed
  • When status is provided, topicId is required
  • Every successful update creates a task system message in the topic
patch/v2/tasks/{taskId}

Request

Path parameters

taskIdstring uuid required

The task ID to update

Headers

X-Signaturestring
Example:a3d5f8e7c2b1d4f6a8e9c7b5d3f1a2e4b6c8d0f2e4a6b8c0d2e4f6a8b0c2d4e6

HMAC signature of the request for authentication and replay protection.

Required only when authenticating with a static API key. If you are using an OAuth access token (issued by POST /oauth/token), omit this header — the JWT carries all the authentication and integrity guarantees.

Replay Protection: The signature includes a timestamp to prevent replay attacks. Requests with timestamps older than 5 minutes are rejected.

The signature payload differs by HTTP method:

  • POST/PUT/PATCH/DELETE: HMAC-SHA256 of {timestamp}.{body}
  • GET: HMAC-SHA256 of {timestamp}.{uri}

The signature is calculated as:

  1. Get the current Unix timestamp in milliseconds
  2. Determine the payload:
    • For POST/PUT/PATCH/DELETE: Use {timestamp}.{body} where body is the request body
    • For GET: Use {timestamp}.{uri} where uri is the full request URI (e.g., /v2/members?limit=10)
  3. Calculate HMAC-SHA256 of the combined payload using your API secret
  4. Hex-encode the output
  5. Include the timestamp in the X-Timestamp header

Example for GET request to /v2/members?limit=10:

timestamp = 1699564800000
payload = "1699564800000./v2/members?limit=10"
signature = HMAC-SHA256(secret, payload)
X-Signature: hex(signature)
X-Timestamp: 1699564800000

Example for POST request with body {"topicId":"123","text":"Hello"}:

timestamp = 1699564800000
payload = '1699564800000.{"topicId":"123","text":"Hello"}'
signature = HMAC-SHA256(secret, payload)
X-Signature: hex(signature)
X-Timestamp: 1699564800000

For multipart/form-data requests, sign the exact raw request body bytes (including boundaries and file bytes) as transmitted.

X-Timestampinteger
Example:1699564800000

Unix timestamp in milliseconds when the request was created. Used for replay protection — requests older than 5 minutes are rejected.

Required only when authenticating with a static API key. Omit when using an OAuth access token.

Request body

topicIdstring uuid

Required when status is provided.

namestring

Task title (alias of title). Provide either name or title.

titlestring

Task title. Provide either title or name.

descriptionstring

Task description

assigneestring

Assignee profile ID. Empty string removes assignee.

dueDateinteger

Due date as Unix timestamp in milliseconds. Set to 0 to clear.

status'Open' | 'Done'

Task status

Example request

{
  "topicId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Review webhook integration docs",
  "title": "Review webhook integration docs",
  "description": "Update docs with long polling + multipart examples",
  "assignee": "550e8400-e29b-41d4-a716-446655440001",
  "dueDate": 1699564800000,
  "status": "Done"
}

Response

Task updated successfully

idstring uuid

Updated task ID

updatedAtinteger

Unix timestamp in milliseconds when the task was updated

Changes

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