Outreach: Finish Sequence State

Mark a prospect finished in an Outreach sequence so no more steps run for them.

Tool ID: outreach_finish_sequence_state

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_finish_sequence_state',
  {
    "id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute outreach_finish_sequence_state --input '{
  "id": 123
}' --json

Example response

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

{
  "data": {
    "data": {
      "attributes": {
        "activeAt": "2026-01-15T12:00:00Z",
        "bounceCount": 1,
        "callCompletedAt": "2026-01-15T12:00:00Z"
      },
      "id": 123,
      "relationships": {
        "account": {
          "data": {},
          "links": {}
        },
        "activeStepMailings": {
          "links": {}
        },
        "activeStepTasks": {
          "links": {}
        }
      }
    }
  }
}

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

Input reference

Member Action Finishes an active sequence state.

Name	Type	Required	Default	Details
`payload.id`	`integer`	Yes	—	—

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	—	A descriptor of a currently sequenced prospect, which includes relationships to its sequence, prospect and user.
`result.data.data.attributes.activeAt`	`string \| null`	No	—	The date and time the sequence state was last active. Format: `date-time`.
`result.data.data.attributes.bounceCount`	`integer \| null`	No	—	The total count of bounced mailings during this sequence state.
`result.data.data.attributes.callCompletedAt`	`string \| null`	No	—	The date and time the sequence state last had a call completed. Format: `date-time`.
`result.data.data.attributes.clickCount`	`integer \| null`	No	—	The total count of clicked mailings from this sequence state.
`result.data.data.attributes.createdAt`	`string \| null`	No	—	The date and time the sequence state was created. Format: `date-time`.
`result.data.data.attributes.deliverCount`	`integer \| null`	No	—	The total count of delivered mailings from this sequence state.
`result.data.data.attributes.errorReason`	`string \| null`	No	—	The reason for the most recent error. Maximum length: 255.
`result.data.data.attributes.failureCount`	`integer \| null`	No	—	The total count of failed mailings from this sequence state.
`result.data.data.attributes.negativeReplyCount`	`integer \| null`	No	—	The total count of negative reply mailings from this sequence state.
`result.data.data.attributes.neutralReplyCount`	`integer \| null`	No	—	The total count of neutral reply mailings from this sequence state.
`result.data.data.attributes.openCount`	`integer \| null`	No	—	The total count of opened mailings from this sequence state.
`result.data.data.attributes.optOutCount`	`integer \| null`	No	—	The total count of opted out mailings from this sequence state.
`result.data.data.attributes.pauseReason`	`string \| null`	No	—	The reason for the most recent pause. Maximum length: 255.
`result.data.data.attributes.positiveReplyCount`	`integer \| null`	No	—	The total count of positive reply mailings from this sequence state.
`result.data.data.attributes.repliedAt`	`string \| null`	No	—	The date and time the sequence state last had a mailing reply. Format: `date-time`.
`result.data.data.attributes.replyCount`	`integer \| null`	No	—	The total count of replied mailings from this sequence state.
`result.data.data.attributes.scheduleCount`	`integer \| null`	No	—	The total count of scheduled mailings from this sequence state.
`result.data.data.attributes.state`	`string \| null`	No	—	The current state of the sequence state. Maximum length: 255.
`result.data.data.attributes.stateChangedAt`	`string \| null`	No	—	The date and time the sequence state’s state last changed. Format: `date-time`.
`result.data.data.attributes.updatedAt`	`string \| null`	No	—	The date and time the sequence state 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 account associated with the prospect the sequence state is targeting. You can use only the attribute id to filter sequenceStates 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.activeStepMailings`	`object`	No	—	Any undelivered mailings associated with the current sequence step. Relationship activeStepMailings cannot be used as a filter.
`result.data.data.relationships.activeStepMailings.data`	`array`	No	—	—
`result.data.data.relationships.activeStepMailings.data[].id`	`integer`	No	—	—
`result.data.data.relationships.activeStepMailings.data[].type`	`"mailing"`	No	—	Allowed: `mailing`.
`result.data.data.relationships.activeStepMailings.links`	`object`	No	—	—
`result.data.data.relationships.activeStepMailings.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.activeStepTasks`	`object`	No	—	Any incomplete tasks associated with the current sequence step. Relationship activeStepTasks cannot be used as a filter.
`result.data.data.relationships.activeStepTasks.data`	`array`	No	—	—
`result.data.data.relationships.activeStepTasks.data[].id`	`integer`	No	—	—
`result.data.data.relationships.activeStepTasks.data[].type`	`"task"`	No	—	Allowed: `task`.
`result.data.data.relationships.activeStepTasks.links`	`object`	No	—	—
`result.data.data.relationships.activeStepTasks.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.batchItemCreator`	`object`	No	—	The batch item associated with this creation, if one exists.
`result.data.data.relationships.batchItemCreator.data`	`object \| null`	No	—	—
`result.data.data.relationships.batchItemCreator.data.id`	`integer`	No	—	—
`result.data.data.relationships.batchItemCreator.data.type`	`"batchItem"`	No	—	Allowed: `batchItem`.
`result.data.data.relationships.batchItemCreator.links`	`object`	No	—	—
`result.data.data.relationships.batchItemCreator.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.calls`	`object`	No	—	The calls associated with the sequence state. You can use only the attribute id to filter sequenceStates by calls (e.g. filter[calls][id]=X).

The table shows the first 50 fields. Expand the raw schema below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe outreach_finish_sequence_state --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

​Member Action Finishes an active sequence state.

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Member Action Finishes an active sequence state.

Output reference

Deepline cost

Related documentation