PATCH
/
tasks
/
{id}
Update a task
curl --request PATCH \
  --url https://api.reply.io/v3/tasks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "id": "<string>",
  "ownerId": "<string>",
  "taskType": "email_manual",
  "status": "pending",
  "description": "<string>",
  "contactId": "<string>",
  "accountId": "<string>",
  "sequenceId": "<string>",
  "dueDate": "2023-12-25",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastInteraction": {
    "date": "2023-11-07T05:31:56Z",
    "type": "email",
    "result": "<string>"
  },
  "data": {
    "id": 123,
    "type": "Email",
    "number": "1",
    "delayInMinutes": 0,
    "emailTemplate": {
      "executionMode": "Automatic",
      "templates": [
        {
          "variantId": 1,
          "subject": "Introduction Email",
          "body": "Hi {{firstName}},\n\nI wanted to reach out regarding...",
          "templateId": 456
        }
      ]
    }
  }
}'
{
  "id": "<string>",
  "ownerId": "<string>",
  "taskType": "email_manual",
  "status": "pending",
  "description": "<string>",
  "contactId": "<string>",
  "accountId": "<string>",
  "sequenceId": "<string>",
  "dueDate": "2023-12-25",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastInteraction": {
    "date": "2023-11-07T05:31:56Z",
    "type": "email",
    "result": "<string>"
  },
  "data": {
    "id": 123,
    "type": "Email",
    "number": "1",
    "delayInMinutes": 0,
    "emailTemplate": {
      "executionMode": "Automatic",
      "templates": [
        {
          "variantId": 1,
          "subject": "Introduction Email",
          "body": "Hi {{firstName}},\n\nI wanted to reach out regarding...",
          "templateId": 456
        }
      ]
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Path Parameters

​
id
string
required

Task Id

Body

application/json

Represents a task in the system

​
id
string
required

(Required) Unique task identifier (ULID)

​
ownerId
string
required

(Required) User who owns the task

​
taskType
enum<string>
required

(Required) Kind of action

Available options:
email_manual,
email_auto,
call,
linkedin,
custom
​
status
enum<string>
required

(Required) Current status of the task

Available options:
pending,
completed,
skipped
​
data
object
required

Type-specific data for the task A task for sending emails Email step with template configuration

Example:
{
  "id": 123,
  "type": "Email",
  "number": "1",
  "delayInMinutes": 0,
  "emailTemplate": {
    "executionMode": "Automatic",
    "templates": [
      {
        "variantId": 1,
        "subject": "Introduction Email",
        "body": "Hi {{firstName}},\n\nI wanted to reach out regarding...",
        "templateId": 456
      }
    ]
  }
}
​
description
string

Free-text details for the assignee

​
contactId
string

Contact linked to the task

​
accountId
string

Account linked to the contact

​
sequenceId
string

Sequence the task belongs to (if any)

​
dueDate
string<date>

ISO 8601 date the task is due (YYYY-MM-DD)

​
createdAt
string<date-time>

RFC 3339 timestamp when the task was created

​
updatedAt
string<date-time>

RFC 3339 timestamp of the last update

​
lastInteraction
object

Combined details of the most recent contact touch

Response

200 - application/json

Task updated successfully

Represents a task in the system

​
id
string
required

(Required) Unique task identifier (ULID)

​
ownerId
string
required

(Required) User who owns the task

​
taskType
enum<string>
required

(Required) Kind of action

Available options:
email_manual,
email_auto,
call,
linkedin,
custom
​
status
enum<string>
required

(Required) Current status of the task

Available options:
pending,
completed,
skipped
​
data
object
required

Type-specific data for the task A task for sending emails Email step with template configuration

Example:
{
  "id": 123,
  "type": "Email",
  "number": "1",
  "delayInMinutes": 0,
  "emailTemplate": {
    "executionMode": "Automatic",
    "templates": [
      {
        "variantId": 1,
        "subject": "Introduction Email",
        "body": "Hi {{firstName}},\n\nI wanted to reach out regarding...",
        "templateId": 456
      }
    ]
  }
}
​
description
string

Free-text details for the assignee

​
contactId
string

Contact linked to the task

​
accountId
string

Account linked to the contact

​
sequenceId
string

Sequence the task belongs to (if any)

​
dueDate
string<date>

ISO 8601 date the task is due (YYYY-MM-DD)

​
createdAt
string<date-time>

RFC 3339 timestamp when the task was created

​
updatedAt
string<date-time>

RFC 3339 timestamp of the last update

​
lastInteraction
object

Combined details of the most recent contact touch