Execute Task

POST

tasks

{task_id}

execute

Execute Task

curl --request POST \
  --url https://api.topo.io/v1/tasks/{task_id}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "body": "<string>",
    "type": "email_reply",
    "closeTask": true,
    "emailAddresses": {
      "to": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "cc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "bcc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "replyTo": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ]
    },
    "attachments": []
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payload: {
      body: JSON.stringify('<string>'),
      type: 'email_reply',
      closeTask: true,
      emailAddresses: {
        to: [{email: '<string>', name: '<string>'}],
        cc: [{email: '<string>', name: '<string>'}],
        bcc: [{email: '<string>', name: '<string>'}],
        replyTo: [{email: '<string>', name: '<string>'}]
      },
      attachments: []
    }
  })
};

fetch('https://api.topo.io/v1/tasks/{task_id}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.topo.io/v1/tasks/{task_id}/execute"

payload = { "payload": {
        "body": "<string>",
        "type": "email_reply",
        "closeTask": True,
        "emailAddresses": {
            "to": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ],
            "cc": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ],
            "bcc": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ],
            "replyTo": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ]
        },
        "attachments": []
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reopened_at": "2023-11-07T05:31:56Z",
  "reopen_reason": "REMINDER_RULE",
  "skipped_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "due_date": "2023-12-25",
  "contact": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "linkedin_url": "<string>",
    "job_title": "<string>",
    "company_name": "<string>",
    "company_domain": "<string>"
  },
  "assignee": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "name": "<string>"
  },
  "sequence_template": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "snoozed_until": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer API key issued from Settings → Developers.

Path Parameters

task_id

string<uuid>

required

ID of the task.

Body

application/json

Execute Task payload

payload

EmailReplyPayload · object

required

Task-type-specific execution payload.

EmailReplyPayload
LinkedinReplyPayload
NewLeadReviewPayload
CallPayload
PlaybookApprovalPayload

Hide child attributes

payload.body

string

required

payload.type

string

default:email_reply

Allowed value: "email_reply"

payload.closeTask

boolean

default:true

payload.emailAddresses

EmailAddresses · object | null

Hide child attributes

payload.emailAddresses.to

EmailContact · object[]

required

Hide child attributes

payload.emailAddresses.to.email

string

required

payload.emailAddresses.to.name

string | null

payload.emailAddresses.cc

EmailContact · object[] | null

Hide child attributes

payload.emailAddresses.cc.email

string

required

payload.emailAddresses.cc.name

string | null

payload.emailAddresses.bcc

EmailContact · object[] | null

Hide child attributes

payload.emailAddresses.bcc.email

string

required

payload.emailAddresses.bcc.name

string | null

payload.emailAddresses.replyTo

EmailContact · object[] | null

Hide child attributes

payload.emailAddresses.replyTo.email

string

required

payload.emailAddresses.replyTo.name

string | null

payload.attachments

AttachmentInput · object[]

Hide child attributes

payload.attachments.filename

string

required

payload.attachments.content_type

string

required

payload.attachments.content_id

string

required

payload.attachments.content

string

required

Response

200 - application/json

Successful Response

string<uuid>

required

Unique identifier.

organization_id

string<uuid>

required

Workspace this task belongs to.

type

enum<string>

required

What kind of task this is.

Available options:

EMAIL_REPLY,

LINKEDIN_REPLY,

NEW_LEAD_REVIEW,

CALL,

PLAYBOOK_APPROVAL,

TODO

priority

enum<string>

required

Task priority bucket.

Available options:

HOT,

TODAY,

EXTRA

status

enum<string>

required

Current lifecycle state.

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

SKIPPED

sequence_id

string<uuid> | null

required

Sequence run this task was projected from, if any.

assignee_user_id

string<uuid> | null

required

User the task is assigned to, if any.

disposition

enum<string> | null

required

Outcome for call tasks once executed.

Available options:

ANSWERED,

VOICEMAIL_LEFT,

NO_ANSWER,

INTERESTED,

NOT_INTERESTED,

WRONG_NUMBER

reopened_at

string<date-time> | null

required

When the task was last reopened, if ever.

reopen_reason

enum<string> | null

required

Why the task was reopened, if applicable.

Available options:

REMINDER_RULE

skipped_at

string<date-time> | null

required

When the task was skipped, if applicable.

completed_at

string<date-time> | null

required

When the task was completed, if applicable.

created_at

string<date-time>

required

When the task was created.

updated_at

string<date-time>

required

When the task last changed.

title

string | null

Task title for standalone tasks.

due_date

string<date> | null

Due date for standalone tasks.

contact

PublicContactSummary · object | null

Summary of the contact linked to this task.

Hide child attributes

contact.id

string<uuid>

required

Unique identifier of the contact.

contact.first_name

string | null

First name.

contact.last_name

string | null

Last name.

contact.email

string | null

Email.

contact.linkedin_url

string | null

LinkedIn profile URL.

contact.job_title

string | null

Job title.

contact.company_name

string | null

Employer name.

contact.company_domain

string | null

Employer's primary domain.

assignee

PublicUserSummary · object | null

Summary of the user this task is assigned to.

Hide child attributes

assignee.id

string<uuid>

required

Unique identifier of the user.

assignee.email

string

required

Email address.

assignee.name

string | null

Display name.

sequence_template

PublicSequenceTemplateSummary · object | null

Summary of the sequence template for sequence-derived tasks.

Hide child attributes

sequence_template.id

string<uuid>

required

Unique identifier of the sequence template.

sequence_template.name

string

required

Template name.

snoozed_until

string<date-time> | null

When the task is snoozed until, if deferred.

Execute Task

curl --request POST \
  --url https://api.topo.io/v1/tasks/{task_id}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "body": "<string>",
    "type": "email_reply",
    "closeTask": true,
    "emailAddresses": {
      "to": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "cc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "bcc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "replyTo": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ]
    },
    "attachments": []
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payload: {
      body: JSON.stringify('<string>'),
      type: 'email_reply',
      closeTask: true,
      emailAddresses: {
        to: [{email: '<string>', name: '<string>'}],
        cc: [{email: '<string>', name: '<string>'}],
        bcc: [{email: '<string>', name: '<string>'}],
        replyTo: [{email: '<string>', name: '<string>'}]
      },
      attachments: []
    }
  })
};

fetch('https://api.topo.io/v1/tasks/{task_id}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.topo.io/v1/tasks/{task_id}/execute"

payload = { "payload": {
        "body": "<string>",
        "type": "email_reply",
        "closeTask": True,
        "emailAddresses": {
            "to": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ],
            "cc": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ],
            "bcc": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ],
            "replyTo": [
                {
                    "email": "<string>",
                    "name": "<string>"
                }
            ]
        },
        "attachments": []
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reopened_at": "2023-11-07T05:31:56Z",
  "reopen_reason": "REMINDER_RULE",
  "skipped_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "due_date": "2023-12-25",
  "contact": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "linkedin_url": "<string>",
    "job_title": "<string>",
    "company_name": "<string>",
    "company_domain": "<string>"
  },
  "assignee": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "name": "<string>"
  },
  "sequence_template": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "snoozed_until": "2023-11-07T05:31:56Z"
}

Overview

Users

Contacts

Accounts

Sequences & Tasks

Events & Webhooks

Execute Task

Authorizations

Path Parameters

Body

Response