> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Outreach: Update Sequence

> Update an Outreach sequence's name, settings, or enabled status by ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Update an Outreach sequence's name, settings, or enabled status by ID.

> [!NOTE]
>
> Tool ID: `outreach_update_sequence`

## 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'outreach_update_sequence',
  {
    "id": 123,
    "data": {
      "id": 123,
      "type": "sequence"
    }
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute outreach_update_sequence --input '{
  "id": 123,
  "data": {
    "id": 123,
    "type": "sequence"
  }
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": {
      "id": 123,
      "type": "example"
    }
  }
}
```

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

## Input reference

Update a Sequence

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `integer` | Yes | — | — |
| `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]. |

> [!NOTE]
>
> This input schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_update_sequence --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 | — | Leverage emailing within Sequences to engage each individual persona more effectively, and queue up the right actions at the right time. |
| `result.data.data.attributes.automationPercentage` | `number \| null` | No | — | The percentage of "auto\_email" sequence steps in this sequence. Format: `float`. |
| `result.data.data.attributes.bounceCount` | `integer \| null` | No | — | The total count of bounced mailings during this sequence. |
| `result.data.data.attributes.clickCount` | `integer \| null` | No | — | The total count of clicked mailings from this sequence. |
| `result.data.data.attributes.createdAt` | `string \| null` | No | — | The date and time the sequence was created. Format: `date-time`. |
| `result.data.data.attributes.deliverCount` | `integer \| null` | No | — | The total count of delivered mailings from this sequence. |
| `result.data.data.attributes.description` | `string \| null` | No | — | A custom description for the sequence. Maximum length: 1024. |
| `result.data.data.attributes.durationInDays` | `integer \| null` | No | — | The total number of days it takes to get through this sequence. |
| `result.data.data.attributes.enabled` | `boolean \| null` | No | — | A boolean value determining whether the sequence is enabled or not. |
| `result.data.data.attributes.enabledAt` | `string \| null` | No | — | The date and time the sequence was enabled, or null if currently disabled. Format: `date-time`. |
| `result.data.data.attributes.failureCount` | `integer \| null` | No | — | The total count of failed mailings from this sequence. |
| `result.data.data.attributes.finishOnReply` | `boolean \| null` | No | — | Deprecated. This boolean value exists only to maintain backward compatibility and primaryReplyAction should be used instead. True if primaryReplyAction is "finish", false otherwise. |
| `result.data.data.attributes.lastUsedAt` | `string \| null` | No | — | The date and time the sequence was last used. Format: `date-time`. |
| `result.data.data.attributes.locked` | `boolean \| null` | No | — | A boolean value determining whether the sequence is locked or not. |
| `result.data.data.attributes.lockedAt` | `string \| null` | No | — | The date and time the sequence was locked, or null if currently unlocked. Format: `date-time`. |
| `result.data.data.attributes.maxActivations` | `integer \| null` | No | — | The maximum number of prospects that can be associated with the sequence. Only applies if the sequence type is "date". |
| `result.data.data.attributes.name` | `string \| null` | No | — | The name or the sequence. Maximum length: 255. |
| `result.data.data.attributes.negativeReplyCount` | `integer \| null` | No | — | The total count of negative reply mailings from this sequence. |
| `result.data.data.attributes.neutralReplyCount` | `integer \| null` | No | — | The total count of neutral reply mailings from this sequence. |
| `result.data.data.attributes.numContactedProspects` | `integer \| null` | No | — | The total count of prospects who have been either called or emailed. |
| `result.data.data.attributes.numRepliedProspects` | `integer \| null` | No | — | The total count of prospects who have been marked as replied. |
| `result.data.data.attributes.openCount` | `integer \| null` | No | — | The total count of opened mailings from this sequence. |
| `result.data.data.attributes.optOutCount` | `integer \| null` | No | — | The total count of opted out mailings from this sequence. |
| `result.data.data.attributes.positiveReplyCount` | `integer \| null` | No | — | The total count of positive reply mailings from this sequence. |
| `result.data.data.attributes.primaryReplyAction` | `string \| null` | No | — | The action to take when the primary prospect replies. Must be one of "finish", "continue", or "pause". Maximum length: 4. |
| `result.data.data.attributes.primaryReplyPauseDuration` | `integer \| null` | No | — | The duration in seconds to pause for (before automatically finishing) after a reply from the primary prospect if the primaryReplyAction is "pause". |
| `result.data.data.attributes.replyCount` | `integer \| null` | No | — | The total count of replied mailings from this sequence. |
| `result.data.data.attributes.salesMotion` | `string \| null` | No | — | The sales engagement type of the sequence. Maximum length: 255. |
| `result.data.data.attributes.scheduleCount` | `integer \| null` | No | — | The total count of scheduled mailings from this sequence. |
| `result.data.data.attributes.scheduleIntervalType` | `string \| null` | No | — | The schedule interval type must be either "calendar" or "schedule" Maximum length: 255. |
| `result.data.data.attributes.secondaryReplyAction` | `string \| null` | No | — | The action to take when someone other than the primary prospect replies. Must be one of "finish", "continue", or "pause". Maximum length: 4. |
| `result.data.data.attributes.secondaryReplyPauseDuration` | `integer \| null` | No | — | The duration in seconds to pause for (before automatically finishing) after a reply from anyone other than the primary prospect if the secondaryReplyAction is "pause". |
| `result.data.data.attributes.sequenceStepCount` | `integer \| null` | No | — | The total number of sequence steps in this sequence. |
| `result.data.data.attributes.sequenceType` | `string \| null` | No | — | The sequence type must be either "date" or "interval". Maximum length: 255. |
| `result.data.data.attributes.shareType` | `string \| null` | No | — | The sequence share type must be either "private", "read\_only" or "shared". Maximum length: 255. |
| `result.data.data.attributes.tags` | `array \| null` | No | — | A list of tag values associated with the sequence (e.g. \["Tier 1", "Inbound Leads"]) |
| `result.data.data.attributes.throttleCapacity` | `integer \| null` | No | — | The maximum number of associated sequence states per user that can be active at a one time. |
| `result.data.data.attributes.throttleMaxAddsPerDay` | `integer \| null` | No | — | The maximum number of associated sequence states per user that can be added to the sequence each day. |
| `result.data.data.attributes.throttlePaused` | `boolean \| null` | No | — | A boolean value determining whether the throttling of sequence states is paused or not. |
| `result.data.data.attributes.throttlePausedAt` | `string \| null` | No | — | The date and time the sequence state throttling was paused, or null if not currently paused. Format: `date-time`. |
| `result.data.data.attributes.transactional` | `boolean \| null` | No | — | A boolean value determining whether prospect opt out preferences are respected. Intended only for non-marketing sequences. |
| `result.data.data.attributes.updatedAt` | `string \| null` | No | — | The date and time the sequence was last updated. Format: `date-time`. |
| `result.data.data.id` | `integer` | Yes | — | — |
| `result.data.data.relationships` | `object` | No | — | — |
| `result.data.data.relationships.calls` | `object` | No | — | The associated calls. You can use only the attribute id to filter sequences 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.contentCategoryMemberships` | `object` | No | — | The content categories (collections) of the sequence. You can use only the attribute id to filter sequences by contentCategoryMemberships (e.g. filter\[contentCategoryMemberships]\[id]=X). |

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

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_update_sequence --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.

## Related documentation

* [Outreach provider guide](https://deepline.com/docs/providers/outreach/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.