- list tasks
- skip tasks
- complete tasks
-
Getting a list of tasks via
GET /tasks/
- Doing something about them outside Amplemarket
- Skipping or completing the task via API
Only
scheduled
and manual tasks can be completed via API (status = scheduled
and automatic = false
)Task Object
Field | Type | Description |
---|---|---|
id | string | The ID of the Task |
automatic | boolean | Whether the task was automatically created (e.g., by a sequence) |
type | string | The type of the task (e.g., phone_call , email ) |
status | string | The status of the task (e.g., scheduled , completed , skipped ) |
due_on | string | The due date and time in ISO 8601 format |
finished_on | string | The completion date and time in ISO 8601 format (null if not finished) |
notes | string | Custom notes associated with the task |
sequence_key | string | The ID of the sequence that created the task (null if not from a sequence) |
sequence_name | string | The name of the sequence that created the task (null if not from a sequence) |
user_id | string | The ID of the user assigned to the task |
user_email | string | The email of the user assigned to the task |
contact | object | The contact associated with the task |
contact.id | string | The ID of the contact |
contact.name | string | The name of the contact |
contact.email | string | The email of the contact |
Example Task Object
Errors
Attempting to Complete an Ineligible Task
If you attempt to complete an already completed task, the API will handle it gracefully and return an HTTP 200
scheduled
status), you will receive an error response: