Task

An item that requires action to complete.

action
string <= 255 characters

The action type of the task. Can be 'action_item', 'call', 'email', or 'in_person'.

autoskipAt
string <date-time>

The optional date and time when the task will automatically be skipped. Tasks with an empty autoskip_at will never be autoskipped.

compiledSequenceTemplateHtml
string

The compiled template HTML of incomplete SMS or LinkedIn tasks associated with a sequence.

completed
boolean

A boolean value whether the task has been completed.

completedAt
string <date-time>

The date and time the task was completed.

createdAt
string <date-time>

The date and time the task was created.

dueAt
string <date-time>

The date and time the task is due.

note
string <= 65535 characters

An optional note for the task.

opportunityAssociation
string <= 255 characters

The optional opportunity rule associated with the task. Can be 'recent_created', 'recent_updated', 'noop'.

scheduledAt
string <date-time>

The date and time the pending task is scheduled for.

state
string <= 255 characters

The current state of the task. Can be 'pending', 'incomplete', or 'complete'.

stateChangedAt
string <date-time>

The date and time the state last changed.

taskType
string <= 255 characters

The type of task. Can be 'follow_up', 'manual', 'no_reply', 'sequence_open', 'sequence_click', 'sequence_step_call', 'sequence_step_email', 'sequence_step_linkedin_interact_with_post', 'sequence_step_linkedin_other', 'sequence_step_linkedin_send_connection_request', 'sequence_step_linkedin_send_message', 'sequence_step_linkedin_view_profile', 'sequence_step_sms', 'sequence_step_task', or 'touch'. Tasks created through the API will automatically be 'manual' tasks.

updatedAt
string <date-time>

The date and time the task was last updated.

{
}

Task Relationships

data (object) or links (object) (account)

The associated account. You can use only the attribute id to filter tasks by account (e.g. filter[account][id]=X).

data (object) or links (object) (call)

The associated call, if a call task. You can use only the attribute id to filter tasks by call (e.g. filter[call][id]=X).

Array of links (object) (call)

The associated calls, if a call task. You can use only the attribute id to filter tasks by calls (e.g. filter[calls][id]=X).

data (object) or links (object) (user)

The completer of this task. You can use only the attribute id to filter tasks by completer (e.g. filter[completer][id]=X).

(stage (data (object) or links (object))) or (user (data (object) or links (object))) or (sequenceStep (data (object) or links (object)))

The creator of this task. Relationship creator cannot be used as a filter.

data (object) or links (object) (mailing)

The associated mailing, if a mailing task. You can use only the attribute id to filter tasks by mailing (e.g. filter[mailing][id]=X).

Array of links (object) (mailing)

The associated mailings, if a mailing task. You can use only the attribute id to filter tasks by mailings (e.g. filter[mailings][id]=X).

data (object) or links (object) (opportunity)

The associated opportunity. You can use only the attribute id to filter tasks by opportunity (e.g. filter[opportunity][id]=X).

data (object) or links (object) (user)

The owner of this task. You can use attributes id, email and firstName to filter tasks by owner (e.g. filter[owner][id]=X).

data (object) or links (object) (prospect)

The associated prospect. You can use attributes id, byPersonaId, byStageId, createdAt, firstName, tags, title and updatedAt to filter tasks by prospect (e.g. filter[prospect][id]=X).

data (object) or links (object) (sequence)

The associated sequence. You can use attributes id and tags to filter tasks by sequence (e.g. filter[sequence][id]=X).

Array of data (object) or links (object) (sequenceStep)

The sequence steps of the associated sequence. You can use only the attribute id to filter tasks by sequenceSequenceSteps (e.g. filter[sequenceSequenceSteps][id]=X).

data (object) or links (object) (sequenceState)

The associated sequence state. You can use only the attribute id to filter tasks by sequenceState (e.g. filter[sequenceState][id]=X).

data (object) or links (object) (sequenceStep)

The associated sequence step. You can use attributes id and stepType to filter tasks by sequenceStep (e.g. filter[sequenceStep][id]=X).

data (object) or links (object) (sequenceTemplate)

The associated sequence template. You can use only the attribute id to filter tasks by sequenceTemplate (e.g. filter[sequenceTemplate][id]=X).

(account (data (object) or links (object))) or (opportunity (data (object) or links (object))) or (prospect (data (object) or links (object)))

The task's subject, either an account or prospect. Relationship subject cannot be used as a filter.

data (object) or links (object) (taskPriority)

The associated task priority. You can use attributes id and name to filter tasks by taskPriority (e.g. filter[taskPriority][id]=X).

data (object) or links (object) (template)

The associated template. You can use only the attribute id to filter tasks by template (e.g. filter[template][id]=X).

{
}

Task Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Task has to external sources. provideDataConnections

⌵ Task Actions

Get a Collection of Tasks

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/tasks
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Task
SecuritybearerAuth and s2sAuthToken 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/tasks
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Task by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/tasks/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get a Task by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/tasks/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update a Task
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/tasks/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Advance
Member Action


Advances the sequence state associated with the task to the next step in the sequence. Note that only tasks with task_type of 'sequence_step_call', 'sequence_step_email', 'sequence_step_linkedin_interact_with_post', 'sequence_step_linkedin_other', 'sequence_step_linkedin_send_connection_request', 'sequence_step_linkedin_send_message', 'sequence_step_linkedin_view_profile', 'sequence_step_sms' or 'sequence_step_task' can be advanced.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/advance
Request samples 
Response samples 
application/vnd.api+json
{
}
Deliver
Member Action


Schedules the mailing associated with the task for delivery, if possible.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/deliver
Request samples 
Response samples 
application/vnd.api+json
{
}
Mark Complete
Member Action


Marks the task as complete.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
query Parameters
object
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/markComplete
Request samples 
Response samples 
application/vnd.api+json
{
}
Reassign Owner
Member Action


Reassigns the owner of a task


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
query Parameters
object
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/reassignOwner
Request samples 
Response samples 
application/vnd.api+json
{
}
Reschedule
Member Action


Reschedules a task by setting a new task due time.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
query Parameters
object
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/reschedule
Request samples 
Response samples 
application/vnd.api+json
{
}
Snooze
Member Action


Sets the 'dueAt' value to be a day later than either now or the existing 'dueAt' value, whichever is later.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
query Parameters
object
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/snooze
Request samples 
Response samples 
application/vnd.api+json
{
}
Update Note
Member Action


Updates note of a task


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
query Parameters
object
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/updateNote
Request samples 
Response samples 
application/vnd.api+json
{
}
Update Opportunity Association
Member Action


Updates opportunity association of a task


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
query Parameters
object
 
Responses 
200
OK


422
JSON error message


post/tasks/{id}/actions/updateOpportunityAssociation
Request samples 
Response samples 
application/vnd.api+json
{
}