Outreach: Create Snippet

Create an Outreach content snippet.

Tool ID: outreach_create_snippet

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);

CLI

deepline tools execute outreach_create_snippet --input '{
  "data": {
    "type": "snippet"
  }
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "data": {
      "attributes": {
        "bodyHtml": "example",
        "bodyText": "example",
        "createdAt": "2026-01-15T12:00:00Z"
      },
      "id": 123,
      "relationships": {
        "contentCategoryMemberships": {
          "links": {}
        },
        "creator": {
          "data": {},
          "links": {}
        },
        "favorites": {
          "links": {}
        }
      }
    }
  }
}

Use deepline tools get outreach_create_snippet --json for the latest machine-readable contract.

Input reference

Create a New Snippet

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

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 piece of an email to be reused in multiple messages.
`result.data.data.attributes.bodyHtml`	`string \| null`	No	—	The HTML of the snippet. Maximum length: 16777215.
`result.data.data.attributes.bodyText`	`string \| null`	No	—	The text of the snippet. Maximum length: 16777215.
`result.data.data.attributes.createdAt`	`string \| null`	No	—	The date and time the snippet was created. Format: `date-time`.
`result.data.data.attributes.name`	`string \| null`	No	—	The name of the snippet. Maximum length: 255.
`result.data.data.attributes.shareType`	`string \| null`	No	—	The permissions for sharing the snippet; must be “private” or “shared.” Maximum length: 255.
`result.data.data.attributes.tags`	`array \| null`	No	—	A list of tags associated with the snippet (e.g. [“Useful”, “Prospecting”]).
`result.data.data.attributes.updatedAt`	`string \| null`	No	—	The date and time the snippet was last updated. Format: `date-time`.
`result.data.data.id`	`integer`	No	—	—
`result.data.data.relationships`	`object`	No	—	—
`result.data.data.relationships.contentCategoryMemberships`	`object`	No	—	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).
`result.data.data.relationships.contentCategoryMemberships.data`	`array`	No	—	—
`result.data.data.relationships.contentCategoryMemberships.data[].id`	`integer`	No	—	—
`result.data.data.relationships.contentCategoryMemberships.data[].type`	`"contentCategoryMembership"`	No	—	Allowed: `contentCategoryMembership`.
`result.data.data.relationships.contentCategoryMemberships.links`	`object`	No	—	—
`result.data.data.relationships.contentCategoryMemberships.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.creator`	`object`	No	—	The creator of the snippet. You can use only the attribute id to filter snippets by creator (e.g. filter[creator][id]=X).
`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`	`"user"`	No	—	Allowed: `user`.
`result.data.data.relationships.creator.links`	`object`	No	—	—
`result.data.data.relationships.creator.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.favorites`	`object`	No	—	The snippet favorited by the user.
`result.data.data.relationships.favorites.data`	`array`	No	—	—
`result.data.data.relationships.favorites.data[].id`	`integer`	No	—	—
`result.data.data.relationships.favorites.data[].type`	`"favorite"`	No	—	Allowed: `favorite`.
`result.data.data.relationships.favorites.links`	`object`	No	—	—
`result.data.data.relationships.favorites.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.owner`	`object`	No	—	The owner of the snippet. You can use only the attribute id to filter snippets by owner (e.g. filter[owner][id]=X).
`result.data.data.relationships.owner.data`	`object \| null`	No	—	—
`result.data.data.relationships.owner.data.id`	`integer`	No	—	—
`result.data.data.relationships.owner.data.type`	`"user"`	No	—	Allowed: `user`.
`result.data.data.relationships.owner.links`	`object`	No	—	—
`result.data.data.relationships.owner.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.updater`	`object`	No	—	The updater of the snippet. You can use only the attribute id to filter snippets by updater (e.g. filter[updater][id]=X).
`result.data.data.relationships.updater.data`	`object \| null`	No	—	—
`result.data.data.relationships.updater.data.id`	`integer`	No	—	—
`result.data.data.relationships.updater.data.type`	`"user"`	No	—	Allowed: `user`.
`result.data.data.relationships.updater.links`	`object`	No	—	—
`result.data.data.relationships.updater.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.type`	`string`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Outreach: Create Snippet

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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