Skip to main content
PATCH
/
v2
/
tasks
/
{taskId}
curl --request PATCH \ --url https://api.zenzap.co/v2/tasks/{taskId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Signature: <api-key>' \ --header 'X-Timestamp: <x-timestamp>' \ --data ' { "topicId": "550e8400-e29b-41d4-a716-446655440000", "status": "Done" } '
{
  "id": "880e8400-e29b-41d4-a716-446655440003",
  "updatedAt": 1699564800000
}

Authorizations

​
Authorization
string
header
required

Use your API key as the Bearer token. You can view your API key and secret in your Zenzap organization API key settings.

​
X-Signature
string
header
required

HMAC-SHA256 signature for request verification.

Headers

​
X-Signature
string
required

HMAC signature of the request for authentication and replay protection.

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.

Pattern: ^[a-f0-9]{64}$
Example:

"a3d5f8e7c2b1d4f6a8e9c7b5d3f1a2e4b6c8d0f2e4a6b8c0d2e4f6a8b0c2d4e6"

​
X-Timestamp
integer<int64>
required

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

Example:

1699564800000

Path Parameters

​
taskId
string<uuid>
required

The task ID to update

Body

application/json

Partial task update payload. At least one field must be provided.

​
topicId
string<uuid>

Required when status is provided.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string

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

Maximum string length: 256
Example:

"Review webhook integration docs"

​
title
string

Task title. Provide either title or name.

Maximum string length: 256
Example:

"Review webhook integration docs"

​
description
string

Task description

Maximum string length: 10000
Example:

"Update docs with long polling + multipart examples"

​
assignee
string

Assignee profile ID. Empty string removes assignee.

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
dueDate
integer<int64>

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

Example:

1699564800000

​
status
enum<string>

Task status

Available options:
Open,
Done
Example:

"Done"

Response

Task updated successfully

​
id
string<uuid>

Updated task ID

​
updatedAt
integer<int64>

Unix timestamp in milliseconds when the task was updated