Update a task

Update the details of an existing task.

Request

PATCH https://superinterface.ai/api/cloud/tasks/{taskId}

Authentication

Include your private API key in the request headers:

Authorization: Bearer YOUR_PRIVATE_API_KEY

Path Parameters

Parameter	Type	Description
`taskId`	string	The ID of an existing task to update

Request Body

Parameter	Type	Required	Description
`title`	string	No	New task title
`message`	string	No	New message payload
`schedule`	object	No	New JSCalendar schedule definition
`key`	string	No	New key used to scope tasks

schedule uses the JSCalendar format. Provide a start date, optional timeZone, and an optional recurrenceRules array.

Example request

curl -X PATCH "https://superinterface.ai/api/cloud/tasks/70cfe680-fee5-49b9-b386-6a7097eb8497" \ -H "Authorization: Bearer YOUR_PRIVATE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Updated reminder" }'

Response

Parameter	Type	Description
`task`	Task	Updated Task

Example response

{ "task": { "id": "70cfe680-fee5-49b9-b386-6a7097eb8497", "title": "Updated reminder", "message": "Check in with the user", "schedule": { "start": "2025-07-01T09:00:00", "timeZone": "America/New_York", "recurrenceRules": [ { "frequency": "daily" } ] }, "threadId": "60cfe680-fee5-49b9-b386-6a7097eb8497", "key": "", "createdAt": "2025-07-01T09:00:00Z", "updatedAt": "2025-07-02T12:00:00Z" } }

key scopes the task pool. Leave it blank to share tasks across assistants. If the tasks tool uses a key template, that template resolves to this value when the task is updated.

Errors

The endpoint may return the following errors:

401 Unauthorized

This error occurs if the API key is invalid or missing.

{ "error": "Unauthorized", "message": "Invalid or missing API key" }