Update Task

CUSTOM-ENDPOINT

PUT https://api.speakap.io/networks/:eid/tasks/:eid/

CUSTOM-REQUEST

  • URI: /networks/{networkEID}/tasks/{taskEID}/
  • Method: PUT
  • Content-Type: application/json
  • Authentication: OAuth 2.0

Alternative Method

This endpoint also supports POST method for backwards compatibility.

POST https://api.speakap.io/networks/:eid/tasks/:eid/

Parameters

NameTypeDescription
networkEIDEIDNetwork EID
taskEIDEIDTask EID

Request Body

Supply a task resource in the request body.

NameTypeDescription
titlestringTitle of the task. Required field.
messageTypestringMust be task. Required field.
taskTypestringType of the task. One of: associated, individual, shared, split. Required field.
recipientsarrayList of recipient objects. Required field.
recipients[i].EIDEIDEID of the recipient (user, group, or network)
recipients[i].typestringuser, group, or network
dueDatedatetimeThe due date for the task. Optional field.
attachmentsarrayList of attachment objects. Optional field.

Example (task)

{
    "title": "Updated task title",
    "messageType": "task",
    "taskType": "individual",
    "recipients": [
        {
            "EID": "{{UserEID}}",
            "type": "user"
        }
    ],
    "dueDate": "2025-01-20T17:00:00.000+00:00",
    "attachments": []
}

Response

StatusData
202Task update accepted: returns a Feedback object
400Invalid task data: returns an Error object
401Unauthorized: returns an Error object
403Permission denied: returns an Error object
404Task not found: returns an Error object