> ## 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
> Create an Outreach content snippet. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=outreach_create_snippet:{"data":{}}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ----------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `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]. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Create a New Snippet",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "A piece of an email to be reused in multiple messages.",
"properties": {
"bodyHtml": {
"type": [
"string",
"null"
],
"description": "The HTML of the snippet.",
"maxLength": 16777215
},
"bodyText": {
"type": [
"string",
"null"
],
"description": "The text of the snippet.",
"maxLength": 16777215
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the snippet was created.",
"format": "date-time"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the snippet.",
"maxLength": 255
},
"shareType": {
"type": [
"string",
"null"
],
"description": "The permissions for sharing the snippet; must be \"private\" or \"shared.\"",
"maxLength": 255
},
"tags": {
"type": [
"array",
"null"
],
"description": "A list of tags associated with the snippet (e.g. [\"Useful\", \"Prospecting\"]).",
"items": {
"type": "string"
}
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the snippet was last updated.",
"format": "date-time"
}
},
"additionalProperties": false
},
"relationships": {
"type": "object",
"properties": {
"contentCategoryMemberships": {
"description": "The content categories (collections) of the snippet. You can use only the attribute id to filter snippets by contentCategoryMemberships (e.g. filter[contentCategoryMemberships][id]=X).",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"contentCategoryMembership"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the snippet. You can use only the attribute id to filter snippets by creator (e.g. filter[creator][id]=X).",
"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
},
"favorites": {
"description": "The snippet favorited by the user.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"favorite"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"owner": {
"description": "The owner of the snippet. You can use only the attribute id to filter snippets by owner (e.g. filter[owner][id]=X).",
"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
},
"updater": {
"description": "The updater of the snippet. You can use only the attribute id to filter snippets by updater (e.g. filter[updater][id]=X).",
"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",
"enum": [
"snippet"
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"include": {
"type": "string",
"description": "Comma-separated related resources to include."
},
"fields": {
"type": "object",
"description": "Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].",
"properties": {
"account": {
"type": "string"
},
"accountNote": {
"type": "string"
},
"auditLog": {
"type": "string"
},
"batch": {
"type": "string"
},
"batchItem": {
"type": "string"
},
"call": {
"type": "string"
},
"callDisposition": {
"type": "string"
},
"callPurpose": {
"type": "string"
},
"complianceRequest": {
"type": "string"
},
"contentCategory": {
"type": "string"
},
"contentCategoryMembership": {
"type": "string"
},
"contentCategoryOwnership": {
"type": "string"
},
"customDuty": {
"type": "string"
},
"duty": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"event": {
"type": "string"
},
"favorite": {
"type": "string"
},
"import": {
"type": "string"
},
"kaiaRecording": {
"type": "string"
},
"kaiaVoiceImport": {
"type": "string"
},
"mailAlias": {
"type": "string"
},
"mailbox": {
"type": "string"
},
"mailing": {
"type": "string"
},
"opportunity": {
"type": "string"
},
"opportunityProspectRole": {
"type": "string"
},
"opportunityStage": {
"type": "string"
},
"orgSetting": {
"type": "string"
},
"persona": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"product": {
"type": "string"
},
"profile": {
"type": "string"
},
"prospect": {
"type": "string"
},
"prospectNote": {
"type": "string"
},
"purchase": {
"type": "string"
},
"recipient": {
"type": "string"
},
"role": {
"type": "string"
},
"ruleset": {
"type": "string"
},
"sequence": {
"type": "string"
},
"sequenceState": {
"type": "string"
},
"sequenceStep": {
"type": "string"
},
"sequenceTemplate": {
"type": "string"
},
"snippet": {
"type": "string"
},
"stage": {
"type": "string"
},
"task": {
"type": "string"
},
"taskDisposition": {
"type": "string"
},
"taskPriority": {
"type": "string"
},
"taskPurpose": {
"type": "string"
},
"team": {
"type": "string"
},
"template": {
"type": "string"
},
"user": {
"type": "string"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### 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 piece of an email to be reused in multiple messages.",
"properties": {
"bodyHtml": {
"type": [
"string",
"null"
],
"description": "The HTML of the snippet.",
"maxLength": 16777215
},
"bodyText": {
"type": [
"string",
"null"
],
"description": "The text of the snippet.",
"maxLength": 16777215
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the snippet was created.",
"format": "date-time"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the snippet.",
"maxLength": 255
},
"shareType": {
"type": [
"string",
"null"
],
"description": "The permissions for sharing the snippet; must be \"private\" or \"shared.\"",
"maxLength": 255
},
"tags": {
"type": [
"array",
"null"
],
"description": "A list of tags associated with the snippet (e.g. [\"Useful\", \"Prospecting\"]).",
"items": {
"type": "string"
}
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the snippet was last updated.",
"format": "date-time"
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"contentCategoryMemberships": {
"description": "The content categories (collections) of the snippet. You can use only the attribute id to filter snippets by contentCategoryMemberships (e.g. filter[contentCategoryMemberships][id]=X).",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"contentCategoryMembership"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the snippet. You can use only the attribute id to filter snippets by creator (e.g. filter[creator][id]=X).",
"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
},
"favorites": {
"description": "The snippet favorited by the user.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"favorite"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"owner": {
"description": "The owner of the snippet. You can use only the attribute id to filter snippets by owner (e.g. filter[owner][id]=X).",
"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
},
"updater": {
"description": "The updater of the snippet. You can use only the attribute id to filter snippets by updater (e.g. filter[updater][id]=X).",
"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
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute outreach_create_snippet --payload '{
"data": {}
}' --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`.