Create Task

CUSTOM-ENDPOINT

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

CUSTOM-REQUEST

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

Parameters

NameTypeDescription
networkEIDEIDNetwork EID

Request Body

Supply a complete 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.

Task Types

ValueDescription
associatedTask associated with another entity
individualIndividual task assigned to specific users
sharedShared task that can be completed by any assignee
splitSplit task where each assignee completes their own portion

Example (task)

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

Response

StatusData
200Task created successfully: returns a Task resource
400Invalid task data: returns an Error object
401Unauthorized: returns an Error object
403Permission denied: returns an Error object
404Network not found: returns an Error object