Create a task

Create a task linked to a phone number, conversation, or conversation activity. Provide exactly one of phoneNumberId, conversationId, or activityId.

POST /v1/tasks

Create a task

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/v1/tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Follow up with customer",
  "description": "Discuss pricing and onboarding next steps.",
  "phoneNumberId": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "assignedTo": "<string>"
}
'

201

{
  "data": {
    "taskId": "<string>",
    "revision": "<string>",
    "phoneNumberId": "<string>",
    "conversationId": "<string>",
    "activityId": "<string>"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Body

application/json

Option 1

Option 2

Option 3

The task to create. Provide exactly one of phoneNumberId, conversationId, or activityId to link the task to that resource.

title · string · required

The title of the task.

Example:

"Follow up with customer"

description · string · required

The description of the task.

Example:

"Discuss pricing and onboarding next steps."

phoneNumberId · string · required

Pattern: ^PN(.*)$

dueDate · string<date-time>

assignedTo · string

Pattern: ^US(.*)$

Response

201

application/json

Created

data · object · required

Show child attributes