Skip to main content
POST
/
v3
/
tasks
/
{id}
/
execute
Execute and complete a task
curl --request POST \
  --url https://api.reply.io/v3/tasks/{id}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": {
    "body": "<string>",
    "subject": "<string>"
  },
  "emailAccountId": 123
}
'
{
  "id": 123,
  "contactId": 123,
  "taskType": "toDo",
  "status": "new",
  "linkedInTaskType": "message",
  "sequenceId": 123,
  "sequenceStepId": 123,
  "sequenceStepDisplayName": "<string>",
  "assignedUserId": 123,
  "creationSource": "user",
  "createdAt": "2023-11-07T05:31:56Z",
  "startAt": "2023-11-07T05:31:56Z",
  "dueTo": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z",
  "isFailed": true,
  "isScheduled": true,
  "template": {
    "body": "<string>",
    "subject": "<string>",
    "attachmentIdList": [
      123
    ]
  },
  "content": {
    "body": "<string>",
    "subject": "<string>"
  },
  "deliveryInfo": {
    "email": "<string>",
    "phoneNumber": "<string>",
    "linkedInUrl": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.reply.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

​
id
integer
required

Task ID.

Body

application/json

Request body for executing a task (send email/SMS) and completing it. Only ManualEmail (7) and Sms (8) task types support execution. All fields are optional — an empty object {} uses server-rendered template and default email account.

​
content
TaskContent · object

Final rendered content to send. If omitted, the server renders the stored template automatically.

​
emailAccountId
integer<int64> | null

Email account to send from. Only for non-sequence ManualEmail tasks. If omitted, the user's default email account is used. Ignored for sequence tasks (account resolved from sequence configuration).

Response

Task executed and completed successfully. Returns the updated task.

Full task detail returned by GET by ID, Create, and Update endpoints.

​
id
integer
read-only

Task ID.

​
contactId
integer | null

Associated contact (prospect) ID.

​
taskType
enum<string>

Task type. Possible values: toDo, call, meeting, linkedIn, manualEmail, sms, whatsApp.

Available options:
toDo,
call,
meeting,
linkedIn,
manualEmail,
sms,
whatsApp
​
status
enum<string>
read-only

Task status. Possible values: new, finished, cancelled, archived, sequenceDetached.

Available options:
new,
finished,
cancelled,
archived,
sequenceDetached
​
linkedInTaskType
enum<string> | null

LinkedIn action subtype. Only present for LinkedIn tasks. Possible values: message, connect, inMail, viewProfile.

Available options:
message,
connect,
inMail,
viewProfile
​
sequenceId
integer | null

Sequence ID if this task was created by a sequence.

​
sequenceStepId
integer | null

Sequence step ID. Available when the ExtendedFilterInTasks feature is enabled.

​
sequenceStepDisplayName
string | null

Human-readable sequence step name (e.g. "Step 2 - Email").

​
assignedUserId
integer

ID of the user this task is assigned to.

​
creationSource
enum<string>
read-only

How the task was created. Possible values: user, sequence, meeting.

Available options:
user,
sequence,
meeting
​
createdAt
string<date-time>
read-only

When the task was created.

​
startAt
string<date-time>

Task start time. When isScheduled is true, this is the scheduled execution time.

​
dueTo
string<date-time>

Task due time.

​
finishedAt
string<date-time> | null
read-only

When the task was completed. Null for active tasks.

​
isFailed
boolean
read-only

Whether the task execution failed.

​
isScheduled
boolean

Whether the task is scheduled for automatic execution.

​
template
TaskTemplate · object

Raw task template. For active tasks, may contain {{variable}} placeholders. For finished tasks, contains the final content (raw version is no longer available).

​
content
TaskContent · object

Rendered content with variables resolved. Only populated when includeContent=true query parameter is set. Null by default.

​
deliveryInfo
TaskDeliveryInfo · object

Delivery target information. Populated for ManualEmail (email), Call/SMS (phone), and LinkedIn (URL) tasks. Null for ToDo, Meeting, and WhatsApp tasks.