POpoll-the-people
Tasks

Update task.

Changed on

Updates task metadata, such as the display name. Use this to rename tasks for easier organization and identification. The display name is the only mutable field exposed via the API.

put/api/v1/projects/{projectId}/tasks/{taskId}

Request

Path parameters

projectIdinteger required

The unique identifier of the agent.

taskIdstring required

The task ID. This is the value returned in data.id when you create a task via POST /tasks.

Request body

namestring required

New task name.

Example request

{
  "name": "Revised document analysis"
}

Response

Task renamed successfully.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": "f1b9aaf0-5e4e-11eb-ae93-0242ac130002",
    "project_id": 1,
    "name": "Analyse this document",
    "created_at": "Monday, 01-Jan-24 12:00:00 UTC",
    "updated_at": "Monday, 01-Jan-24 12:00:00 UTC"
  }
}

Changes