Outreach: Create Opportunity

Create an opportunity in Outreach with its name, amount, stage, and account.

Tool ID: outreach_create_opportunity

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_create_opportunity',
  {
    "data": {
      "type": "opportunity"
    }
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute outreach_create_opportunity --input '{
  "data": {
    "type": "opportunity"
  }
}' --json

Example response

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

{
  "data": {
    "data": {
      "attributes": {
        "amount": 1,
        "amountPrecise": "example",
        "closeDate": "2026-01-15T12:00:00Z"
      },
      "id": 123,
      "relationships": {
        "account": {
          "data": {},
          "links": {}
        },
        "assignedTeams": {
          "links": {}
        },
        "assignedUsers": {
          "links": {}
        }
      }
    }
  }
}

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

Input reference

Create a New Opportunity

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

This input schema is too large for an inline display. Read the complete live contract with deepline describe outreach_create_opportunity --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	—	An opportunity for a sale or pending deal. Requires the Opportunities SKU to be enabled in order to have access. Please contact support for more assistance.
`result.data.data.attributes.amount`	`integer \| null`	No	—	The amount the opportunity is worth.
`result.data.data.attributes.amountPrecise`	`string \| null`	No	—	The precise amount that the opportunity is worth. Maximum length: 15.
`result.data.data.attributes.closeDate`	`string \| null`	No	—	The date the opportunity is expected to close. Format: `date-time`.
`result.data.data.attributes.createdAt`	`string \| null`	No	—	The date the opportunity was created. Format: `date-time`.
`result.data.data.attributes.currencyType`	`string \| null`	No	—	The ISO code of the currency this opportunity is in. Maximum length: 255.
`result.data.data.attributes.custom1`	`string \| null`	No	—	The value of the opportunity’s first custom field. Maximum length: 32000.
`result.data.data.attributes.custom2`	`string \| null`	No	—	The value of the opportunity’s second custom field. Maximum length: 32000.
`result.data.data.attributes.custom3`	`string \| null`	No	—	The value of the opportunity’s third custom field. Maximum length: 32000.
`result.data.data.attributes.custom4`	`string \| null`	No	—	The value of the opportunity’s fourth custom field. Maximum length: 32000.
`result.data.data.attributes.custom5`	`string \| null`	No	—	The value of the opportunity’s fifth custom field. Maximum length: 32000.
`result.data.data.attributes.custom6`	`string \| null`	No	—	The value of the opportunity’s sixth custom field. Maximum length: 32000.
`result.data.data.attributes.custom7`	`string \| null`	No	—	The value of the opportunity’s seventh custom field. Maximum length: 32000.
`result.data.data.attributes.custom8`	`string \| null`	No	—	The value of the opportunity’s eighth custom field. Maximum length: 32000.
`result.data.data.attributes.custom9`	`string \| null`	No	—	The value of the opportunity’s ninth custom field. Maximum length: 32000.
`result.data.data.attributes.custom10`	`string \| null`	No	—	The value of the opportunity’s 10th custom field. Maximum length: 32000.
`result.data.data.attributes.custom11`	`string \| null`	No	—	The value of the opportunity’s 11th custom field. Maximum length: 32000.
`result.data.data.attributes.custom12`	`string \| null`	No	—	The value of the opportunity’s 12th custom field. Maximum length: 32000.
`result.data.data.attributes.custom13`	`string \| null`	No	—	The value of the opportunity’s 13th custom field. Maximum length: 32000.
`result.data.data.attributes.custom14`	`string \| null`	No	—	The value of the opportunity’s 14th custom field. Maximum length: 32000.
`result.data.data.attributes.custom15`	`string \| null`	No	—	The value of the opportunity’s 15th custom field. Maximum length: 32000.
`result.data.data.attributes.custom16`	`string \| null`	No	—	The value of the opportunity’s 16th custom field. Maximum length: 32000.
`result.data.data.attributes.custom17`	`string \| null`	No	—	The value of the opportunity’s 17th custom field. Maximum length: 32000.
`result.data.data.attributes.custom18`	`string \| null`	No	—	The value of the opportunity’s 18th custom field. Maximum length: 32000.
`result.data.data.attributes.custom19`	`string \| null`	No	—	The value of the opportunity’s 19th custom field. Maximum length: 32000.
`result.data.data.attributes.custom20`	`string \| null`	No	—	The value of the opportunity’s 20th custom field. Maximum length: 32000.
`result.data.data.attributes.custom21`	`string \| null`	No	—	The value of the opportunity’s 21st custom field. Maximum length: 32000.
`result.data.data.attributes.custom22`	`string \| null`	No	—	The value of the opportunity’s 22nd custom field. Maximum length: 32000.
`result.data.data.attributes.custom23`	`string \| null`	No	—	The value of the opportunity’s 23rd custom field. Maximum length: 32000.
`result.data.data.attributes.custom24`	`string \| null`	No	—	The value of the opportunity’s 24th custom field. Maximum length: 32000.
`result.data.data.attributes.custom25`	`string \| null`	No	—	The value of the opportunity’s 25th custom field. Maximum length: 32000.
`result.data.data.attributes.custom26`	`string \| null`	No	—	The value of the opportunity’s 26th custom field. Maximum length: 32000.
`result.data.data.attributes.custom27`	`string \| null`	No	—	The value of the opportunity’s 27th custom field. Maximum length: 32000.
`result.data.data.attributes.custom28`	`string \| null`	No	—	The value of the opportunity’s 28th custom field. Maximum length: 32000.
`result.data.data.attributes.custom29`	`string \| null`	No	—	The value of the opportunity’s 29th custom field. Maximum length: 32000.
`result.data.data.attributes.custom30`	`string \| null`	No	—	The value of the opportunity’s 30th custom field. Maximum length: 32000.
`result.data.data.attributes.custom31`	`string \| null`	No	—	The value of the opportunity’s 31st custom field. Maximum length: 32000.
`result.data.data.attributes.custom32`	`string \| null`	No	—	The value of the opportunity’s 32nd custom field. Maximum length: 32000.
`result.data.data.attributes.custom33`	`string \| null`	No	—	The value of the opportunity’s 33rd custom field. Maximum length: 32000.
`result.data.data.attributes.custom34`	`string \| null`	No	—	The value of the opportunity’s 34th custom field. Maximum length: 32000.
`result.data.data.attributes.custom35`	`string \| null`	No	—	The value of the opportunity’s 35th custom field. Maximum length: 32000.
`result.data.data.attributes.custom36`	`string \| null`	No	—	The value of the opportunity’s 36th custom field. Maximum length: 32000.
`result.data.data.attributes.custom37`	`string \| null`	No	—	The value of the opportunity’s 37th custom field. Maximum length: 32000.
`result.data.data.attributes.custom38`	`string \| null`	No	—	The value of the opportunity’s 38th custom field. Maximum length: 32000.
`result.data.data.attributes.custom39`	`string \| null`	No	—	The value of the opportunity’s 39th custom field. Maximum length: 32000.
`result.data.data.attributes.custom40`	`string \| null`	No	—	The value of the opportunity’s 40th custom field. Maximum length: 32000.
`result.data.data.attributes.custom41`	`string \| null`	No	—	The value of the opportunity’s 41st custom field. Maximum length: 32000.
`result.data.data.attributes.custom42`	`string \| null`	No	—	The value of the opportunity’s 42nd custom field. Maximum length: 32000.

The table shows the first 50 fields. Use the live contract below for every field.

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

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation