> ## 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 Action Doc: Inputs, Cost & CLI Example

> Finish an active sequence state. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=outreach_finish_sequence_state:{"id":"{{id}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name         | Type      | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ----------- |
| `payload.id` | `integer` | Yes      |         |             |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "### Member Action Finishes an active sequence state.",
    "properties": {
      "id": {
        "type": "integer"
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "attributes": {
                "type": "object",
                "description": "A descriptor of a currently sequenced prospect, which includes relationships to its sequence, prospect and user.",
                "properties": {
                  "activeAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the sequence state was last active.",
                    "format": "date-time"
                  },
                  "bounceCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of bounced mailings during this sequence state."
                  },
                  "callCompletedAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the sequence state last had a call completed.",
                    "format": "date-time"
                  },
                  "clickCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of clicked mailings from this sequence state."
                  },
                  "createdAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the sequence state was created.",
                    "format": "date-time"
                  },
                  "deliverCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of delivered mailings from this sequence state."
                  },
                  "errorReason": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The reason for the most recent error.",
                    "maxLength": 255
                  },
                  "failureCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of failed mailings from this sequence state."
                  },
                  "negativeReplyCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of negative reply mailings from this sequence state."
                  },
                  "neutralReplyCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of neutral reply mailings from this sequence state."
                  },
                  "openCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of opened mailings from this sequence state."
                  },
                  "optOutCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of opted out mailings from this sequence state."
                  },
                  "pauseReason": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The reason for the most recent pause.",
                    "maxLength": 255
                  },
                  "positiveReplyCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of positive reply mailings from this sequence state."
                  },
                  "repliedAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the sequence state last had a mailing reply.",
                    "format": "date-time"
                  },
                  "replyCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of replied mailings from this sequence state."
                  },
                  "scheduleCount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The total count of scheduled mailings from this sequence state."
                  },
                  "state": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The current state of the sequence state.",
                    "maxLength": 255
                  },
                  "stateChangedAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the sequence state’s state last changed.",
                    "format": "date-time"
                  },
                  "updatedAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The date and time the sequence state was last updated.",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "id": {
                "type": "integer"
              },
              "relationships": {
                "type": "object",
                "properties": {
                  "account": {
                    "description": "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).",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "account"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "activeStepMailings": {
                    "description": "Any undelivered mailings associated with the current sequence step. Relationship activeStepMailings cannot be used as a filter.",
                    "properties": {
                      "data": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "mailing"
                              ]
                            }
                          },
                          "additionalProperties": false
                        }
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "activeStepTasks": {
                    "description": "Any incomplete tasks associated with the current sequence step. Relationship activeStepTasks cannot be used as a filter.",
                    "properties": {
                      "data": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "task"
                              ]
                            }
                          },
                          "additionalProperties": false
                        }
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "batchItemCreator": {
                    "description": "The batch item associated with this creation, if one exists.",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "batchItem"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "calls": {
                    "description": "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).",
                    "properties": {
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "creator": {
                    "description": "The creator of the sequence state. Relationship creator cannot be used as a filter.",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "user"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "mailbox": {
                    "description": "The mailbox to use for mailing steps. You can use attributes id and email to filter sequenceStates by mailbox (e.g. filter[mailbox][id]=X).",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "mailbox"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "mailings": {
                    "description": "The mailings associated with the sequence state. Relationship mailings cannot be used as a filter.",
                    "properties": {
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "opportunity": {
                    "description": "The associated opportunity. You can use only the attribute id to filter sequenceStates by opportunity (e.g. filter[opportunity][id]=X).",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "opportunity"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "prospect": {
                    "description": "The primary prospect this sequence state is targeting. You can use attributes id and emails to filter sequenceStates by prospect (e.g. filter[prospect][id]=X).",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "prospect"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "sequence": {
                    "description": "The sequence this prospect is engaged in. You can use any filterable attribute of sequence.",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "sequence"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "sequenceStateRecipients": {
                    "description": "Additional recipients associated with this sequence state.",
                    "properties": {
                      "data": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer"
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "sequenceStateRecipient"
                              ]
                            }
                          },
                          "additionalProperties": false
                        }
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "sequenceStep": {
                    "description": "The current sequence step the prospect is in. You can use any filterable attribute of sequenceStep.",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "sequenceStep"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "tasks": {
                    "description": "The tasks associated with the sequence state. You can use attributes id and dueAt to filter sequenceStates by tasks (e.g. filter[tasks][id]=X).",
                    "properties": {
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  },
                  "user": {
                    "description": "The user managing this sequence state.",
                    "properties": {
                      "data": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "user"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      "links": {
                        "type": "object",
                        "properties": {
                          "related": {
                            "type": "string",
                            "format": "uri"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "additionalProperties": false
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute outreach_finish_sequence_state --payload '{
  "id": "integer"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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