Outreach: Create Task

Create an Outreach task, such as a call or email to-do, for a prospect or account.

Tool ID: outreach_create_task

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'outreach_create_task',
  {
    "data": {
      "type": "task"
    }
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute outreach_create_task --input '{
  "data": {
    "type": "task"
  }
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": {
      "attributes": {
        "action": "example",
        "autoskipAt": "2026-01-15T12:00:00Z",
        "compiledSequenceTemplateHtml": "example"
      },
      "id": 123,
      "relationships": {
        "account": {
          "data": {},
          "links": {}
        },
        "call": {
          "data": {},
          "links": {}
        },
        "calls": {
          "links": {}
        }
      }
    }
  }
}

Use deepline describe outreach_create_task --json for the latest machine-readable contract.

Input reference

Create a New Task

Name	Type	Required	Default	Details
`payload.data`	`object`	Yes	—	—
`payload.include`	`string`	No	—	Comma-separated related resources to include.
`payload.fields`	`object`	No	—	Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].

This input schema is too large for an inline display. Read the complete live contract with deepline describe outreach_create_task --json.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`object`	No	—	—
`result.data.data.attributes`	`object`	No	—	An item that requires action to complete.
`result.data.data.attributes.action`	`string \| null`	No	—	The action type of the task. Can be ‘action_item’, ‘call’, ‘email’, or ‘in_person’. Maximum length: 255.
`result.data.data.attributes.autoskipAt`	`string \| null`	No	—	The optional date and time when the task will automatically be skipped. Tasks with an empty autoskip_at will never be autoskipped. Format: `date-time`.
`result.data.data.attributes.compiledSequenceTemplateHtml`	`string \| null`	No	—	The compiled template HTML of incomplete SMS or LinkedIn tasks associated with a sequence.
`result.data.data.attributes.completed`	`boolean \| null`	No	—	A boolean value whether the task has been completed.
`result.data.data.attributes.completedAt`	`string \| null`	No	—	The date and time the task was completed. Format: `date-time`.
`result.data.data.attributes.createdAt`	`string \| null`	No	—	The date and time the task was created. Format: `date-time`.
`result.data.data.attributes.dueAt`	`string \| null`	No	—	The date and time the task is due. Format: `date-time`.
`result.data.data.attributes.note`	`string \| null`	No	—	An optional note for the task. Maximum length: 65535.
`result.data.data.attributes.opportunityAssociation`	`string \| null`	No	—	The optional opportunity rule associated with the task. Can be ‘recent_created’, ‘recent_updated’, ‘noop’. Maximum length: 255.
`result.data.data.attributes.scheduledAt`	`string \| null`	No	—	The date and time the pending task is scheduled for. Format: `date-time`.
`result.data.data.attributes.state`	`string \| null`	No	—	The current state of the task. Can be ‘pending’, ‘incomplete’, or ‘complete’. Maximum length: 255.
`result.data.data.attributes.stateChangedAt`	`string \| null`	No	—	The date and time the state last changed. Format: `date-time`.
`result.data.data.attributes.taskType`	`string \| null`	No	—	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. Maximum length: 255.
`result.data.data.attributes.updatedAt`	`string \| null`	No	—	The date and time the task was last updated. Format: `date-time`.
`result.data.data.id`	`integer`	No	—	—
`result.data.data.relationships`	`object`	No	—	—
`result.data.data.relationships.account`	`object`	No	—	The associated account. You can use only the attribute id to filter tasks by account (e.g. filter[account][id]=X).
`result.data.data.relationships.account.data`	`object \| null`	No	—	—
`result.data.data.relationships.account.data.id`	`integer`	No	—	—
`result.data.data.relationships.account.data.type`	`"account"`	No	—	Allowed: `account`.
`result.data.data.relationships.account.links`	`object`	No	—	—
`result.data.data.relationships.account.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.call`	`object`	No	—	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).
`result.data.data.relationships.call.data`	`object \| null`	No	—	—
`result.data.data.relationships.call.data.id`	`integer`	No	—	—
`result.data.data.relationships.call.data.type`	`"call"`	No	—	Allowed: `call`.
`result.data.data.relationships.call.links`	`object`	No	—	—
`result.data.data.relationships.call.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.calls`	`object`	No	—	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).
`result.data.data.relationships.calls.links`	`object`	No	—	—
`result.data.data.relationships.calls.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.completer`	`object`	No	—	The completer of this task. You can use only the attribute id to filter tasks by completer (e.g. filter[completer][id]=X).
`result.data.data.relationships.completer.data`	`object \| null`	No	—	—
`result.data.data.relationships.completer.data.id`	`integer`	No	—	—
`result.data.data.relationships.completer.data.type`	`"user"`	No	—	Allowed: `user`.
`result.data.data.relationships.completer.links`	`object`	No	—	—
`result.data.data.relationships.completer.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.creator`	`object`	No	—	The creator of this task. Relationship creator cannot be used as a filter.
`result.data.data.relationships.creator.data`	`object \| null`	No	—	—
`result.data.data.relationships.creator.data.id`	`integer`	No	—	—
`result.data.data.relationships.creator.data.type`	`"sequenceStep" \| "stage" \| "user"`	No	—	Allowed: `sequenceStep`, `stage`, `user`.
`result.data.data.relationships.creator.links`	`object`	No	—	—
`result.data.data.relationships.creator.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.defaultPluginMapping`	`object`	No	—	—
`result.data.data.relationships.defaultPluginMapping.data`	`object \| null`	No	—	—
`result.data.data.relationships.defaultPluginMapping.data.id`	`integer`	No	—	—
`result.data.data.relationships.defaultPluginMapping.data.type`	`"pluginMapping"`	No	—	Allowed: `pluginMapping`.

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe outreach_create_task --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation