> ## 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 opportunity. 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_opportunity:{"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 Opportunity",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "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.",
"properties": {
"amount": {
"type": [
"integer",
"null"
],
"description": "The amount the opportunity is worth."
},
"amountPrecise": {
"type": [
"string",
"null"
],
"description": "The precise amount that the opportunity is worth.",
"maxLength": 15
},
"closeDate": {
"type": [
"string",
"null"
],
"description": "The date the opportunity is expected to close.",
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was created.",
"format": "date-time"
},
"currencyType": {
"type": [
"string",
"null"
],
"description": "The ISO code of the currency this opportunity is in.",
"maxLength": 255
},
"custom1": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's first custom field.",
"maxLength": 32000
},
"custom2": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's second custom field.",
"maxLength": 32000
},
"custom3": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's third custom field.",
"maxLength": 32000
},
"custom4": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's fourth custom field.",
"maxLength": 32000
},
"custom5": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's fifth custom field.",
"maxLength": 32000
},
"custom6": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's sixth custom field.",
"maxLength": 32000
},
"custom7": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's seventh custom field.",
"maxLength": 32000
},
"custom8": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's eighth custom field.",
"maxLength": 32000
},
"custom9": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's ninth custom field.",
"maxLength": 32000
},
"custom10": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 10th custom field.",
"maxLength": 32000
},
"custom11": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 11th custom field.",
"maxLength": 32000
},
"custom12": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 12th custom field.",
"maxLength": 32000
},
"custom13": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 13th custom field.",
"maxLength": 32000
},
"custom14": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 14th custom field.",
"maxLength": 32000
},
"custom15": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 15th custom field.",
"maxLength": 32000
},
"custom16": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 16th custom field.",
"maxLength": 32000
},
"custom17": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 17th custom field.",
"maxLength": 32000
},
"custom18": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 18th custom field.",
"maxLength": 32000
},
"custom19": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 19th custom field.",
"maxLength": 32000
},
"custom20": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 20th custom field.",
"maxLength": 32000
},
"custom21": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 21st custom field.",
"maxLength": 32000
},
"custom22": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 22nd custom field.",
"maxLength": 32000
},
"custom23": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 23rd custom field.",
"maxLength": 32000
},
"custom24": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 24th custom field.",
"maxLength": 32000
},
"custom25": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 25th custom field.",
"maxLength": 32000
},
"custom26": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 26th custom field.",
"maxLength": 32000
},
"custom27": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 27th custom field.",
"maxLength": 32000
},
"custom28": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 28th custom field.",
"maxLength": 32000
},
"custom29": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 29th custom field.",
"maxLength": 32000
},
"custom30": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 30th custom field.",
"maxLength": 32000
},
"custom31": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 31st custom field.",
"maxLength": 32000
},
"custom32": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 32nd custom field.",
"maxLength": 32000
},
"custom33": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 33rd custom field.",
"maxLength": 32000
},
"custom34": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 34th custom field.",
"maxLength": 32000
},
"custom35": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 35th custom field.",
"maxLength": 32000
},
"custom36": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 36th custom field.",
"maxLength": 32000
},
"custom37": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 37th custom field.",
"maxLength": 32000
},
"custom38": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 38th custom field.",
"maxLength": 32000
},
"custom39": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 39th custom field.",
"maxLength": 32000
},
"custom40": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 40th custom field.",
"maxLength": 32000
},
"custom41": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 41st custom field.",
"maxLength": 32000
},
"custom42": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 42nd custom field.",
"maxLength": 32000
},
"custom43": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 43rd custom field.",
"maxLength": 32000
},
"custom44": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 44th custom field.",
"maxLength": 32000
},
"custom45": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 45th custom field.",
"maxLength": 32000
},
"custom46": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 46th custom field.",
"maxLength": 32000
},
"custom47": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 47th custom field.",
"maxLength": 32000
},
"custom48": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 48th custom field.",
"maxLength": 32000
},
"custom49": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 49th custom field.",
"maxLength": 32000
},
"custom50": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 50th custom field.",
"maxLength": 32000
},
"custom51": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 51st custom field.",
"maxLength": 32000
},
"custom52": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 52nd custom field.",
"maxLength": 32000
},
"custom53": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 53rd custom field.",
"maxLength": 32000
},
"custom54": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 54th custom field.",
"maxLength": 32000
},
"custom55": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 55th custom field.",
"maxLength": 32000
},
"custom56": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 56th custom field.",
"maxLength": 32000
},
"custom57": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 57th custom field.",
"maxLength": 32000
},
"custom58": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 58th custom field.",
"maxLength": 32000
},
"custom59": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 59th custom field.",
"maxLength": 32000
},
"custom60": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 60th custom field.",
"maxLength": 32000
},
"custom61": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 61st custom field.",
"maxLength": 32000
},
"custom62": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 62nd custom field.",
"maxLength": 32000
},
"custom63": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 63rd custom field.",
"maxLength": 32000
},
"custom64": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 64th custom field.",
"maxLength": 32000
},
"custom65": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 65th custom field.",
"maxLength": 32000
},
"custom66": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 66th custom field.",
"maxLength": 32000
},
"custom67": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 67th custom field.",
"maxLength": 32000
},
"custom68": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 68th custom field.",
"maxLength": 32000
},
"custom69": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 69th custom field.",
"maxLength": 32000
},
"custom70": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 70th custom field.",
"maxLength": 32000
},
"custom71": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 71st custom field.",
"maxLength": 32000
},
"custom72": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 72nd custom field.",
"maxLength": 32000
},
"custom73": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 73rd custom field.",
"maxLength": 32000
},
"custom74": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 74th custom field.",
"maxLength": 32000
},
"custom75": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 75th custom field.",
"maxLength": 32000
},
"custom76": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 76th custom field.",
"maxLength": 32000
},
"custom77": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 77th custom field.",
"maxLength": 32000
},
"custom78": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 78th custom field.",
"maxLength": 32000
},
"custom79": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 79th custom field.",
"maxLength": 32000
},
"custom80": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 80th custom field.",
"maxLength": 32000
},
"custom81": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 81st custom field.",
"maxLength": 32000
},
"custom82": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 82nd custom field.",
"maxLength": 32000
},
"custom83": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 83rd custom field.",
"maxLength": 32000
},
"custom84": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 84th custom field.",
"maxLength": 32000
},
"custom85": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 85th custom field.",
"maxLength": 32000
},
"custom86": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 86th custom field.",
"maxLength": 32000
},
"custom87": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 87th custom field.",
"maxLength": 32000
},
"custom88": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 88th custom field.",
"maxLength": 32000
},
"custom89": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 89th custom field.",
"maxLength": 32000
},
"custom90": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 90th custom field.",
"maxLength": 32000
},
"custom91": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 91st custom field.",
"maxLength": 32000
},
"custom92": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 92nd custom field.",
"maxLength": 32000
},
"custom93": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 93rd custom field.",
"maxLength": 32000
},
"custom94": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 94th custom field.",
"maxLength": 32000
},
"custom95": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 95th custom field.",
"maxLength": 32000
},
"custom96": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 96th custom field.",
"maxLength": 32000
},
"custom97": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 97th custom field.",
"maxLength": 32000
},
"custom98": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 98th custom field.",
"maxLength": 32000
},
"custom99": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 99th custom field.",
"maxLength": 32000
},
"custom100": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 100th custom field.",
"maxLength": 32000
},
"custom101": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 101st custom field.",
"maxLength": 32000
},
"custom102": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 102nd custom field.",
"maxLength": 32000
},
"custom103": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 103rd custom field.",
"maxLength": 32000
},
"custom104": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 104th custom field.",
"maxLength": 32000
},
"custom105": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 105th custom field.",
"maxLength": 32000
},
"custom106": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 106th custom field.",
"maxLength": 32000
},
"custom107": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 107th custom field.",
"maxLength": 32000
},
"custom108": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 108th custom field.",
"maxLength": 32000
},
"custom109": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 109th custom field.",
"maxLength": 32000
},
"custom110": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 110th custom field.",
"maxLength": 32000
},
"custom111": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 111th custom field.",
"maxLength": 32000
},
"custom112": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 112th custom field.",
"maxLength": 32000
},
"custom113": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 113th custom field.",
"maxLength": 32000
},
"custom114": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 114th custom field.",
"maxLength": 32000
},
"custom115": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 115th custom field.",
"maxLength": 32000
},
"custom116": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 116th custom field.",
"maxLength": 32000
},
"custom117": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 117th custom field.",
"maxLength": 32000
},
"custom118": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 118th custom field.",
"maxLength": 32000
},
"custom119": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 119th custom field.",
"maxLength": 32000
},
"custom120": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 120th custom field.",
"maxLength": 32000
},
"custom121": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 121st custom field.",
"maxLength": 32000
},
"custom122": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 122nd custom field.",
"maxLength": 32000
},
"custom123": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 123rd custom field.",
"maxLength": 32000
},
"custom124": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 124th custom field.",
"maxLength": 32000
},
"custom125": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 125th custom field.",
"maxLength": 32000
},
"custom126": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 126th custom field.",
"maxLength": 32000
},
"custom127": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 127th custom field.",
"maxLength": 32000
},
"custom128": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 128th custom field.",
"maxLength": 32000
},
"custom129": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 129th custom field.",
"maxLength": 32000
},
"custom130": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 130th custom field.",
"maxLength": 32000
},
"custom131": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 131st custom field.",
"maxLength": 32000
},
"custom132": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 132nd custom field.",
"maxLength": 32000
},
"custom133": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 133rd custom field.",
"maxLength": 32000
},
"custom134": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 134th custom field.",
"maxLength": 32000
},
"custom135": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 135th custom field.",
"maxLength": 32000
},
"custom136": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 136th custom field.",
"maxLength": 32000
},
"custom137": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 137th custom field.",
"maxLength": 32000
},
"custom138": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 138th custom field.",
"maxLength": 32000
},
"custom139": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 139th custom field.",
"maxLength": 32000
},
"custom140": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 140th custom field.",
"maxLength": 32000
},
"custom141": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 141st custom field.",
"maxLength": 32000
},
"custom142": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 142nd custom field.",
"maxLength": 32000
},
"custom143": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 143rd custom field.",
"maxLength": 32000
},
"custom144": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 144th custom field.",
"maxLength": 32000
},
"custom145": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 145th custom field.",
"maxLength": 32000
},
"custom146": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 146th custom field.",
"maxLength": 32000
},
"custom147": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 147th custom field.",
"maxLength": 32000
},
"custom148": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 148th custom field.",
"maxLength": 32000
},
"custom149": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 149th custom field.",
"maxLength": 32000
},
"custom150": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 150th custom field.",
"maxLength": 32000
},
"customId": {
"type": [
"string",
"null"
],
"description": "A custom ID for the opportunity, often referencing an ID in an external system.",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
],
"description": "A description of the opportunity.",
"maxLength": 65535
},
"externalCreatedAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was created in the external system.",
"format": "date-time"
},
"externalUpdatedAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was last updated in the external system.",
"format": "date-time"
},
"forecastCategory": {
"type": [
"string",
"null"
],
"description": "The category or classification used to predict the likelihood of closing an opportunity.",
"maxLength": 32000
},
"leadSource": {
"type": [
"string",
"null"
],
"description": "Source of this opportunity, such as Advertisement or Trade Show",
"maxLength": 32000
},
"lostReason": {
"type": [
"string",
"null"
],
"description": "The reason why an opportunity or deal was lost.",
"maxLength": 32000
},
"mapLink": {
"type": [
"string",
"null"
],
"description": "A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.",
"maxLength": 255
},
"mapNextSteps": {
"type": [
"string",
"null"
],
"description": "The next event in the timeline that has yet to be completed for the SamePlan MAP (Mutual Action Plan).",
"maxLength": 255
},
"mapStatus": {
"type": [
"string",
"null"
],
"description": "The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.",
"maxLength": 255
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the opportunity.",
"maxLength": 255
},
"nextStep": {
"type": [
"string",
"null"
],
"description": "The next step to take for the opportunity.",
"maxLength": 65535
},
"opportunityType": {
"type": [
"string",
"null"
],
"description": "The type of opportunity.",
"maxLength": 255
},
"probability": {
"type": [
"integer",
"null"
],
"description": "The chances of the opportunity succeeding, represented as a percentage."
},
"prospectingRepId": {
"type": [
"string",
"null"
],
"description": "The ID of the sales rep that prospects the opportunity.",
"maxLength": 255
},
"recordType": {
"type": [
"string",
"null"
],
"description": "The type or category of the record, such as Opportunity, Lead, or Deal, used to classify and organize different stages in the sales process",
"maxLength": 32000
},
"sharingTeamId": {
"type": [
"string",
"null"
],
"description": "The ID of the sharing team associated with this object. Access is currently in beta.",
"maxLength": 255
},
"tags": {
"type": [
"array",
"null"
],
"description": "Tags associated with the opportunity.",
"items": {
"type": "string"
}
},
"touchedAt": {
"type": [
"string",
"null"
],
"description": "The last time an event happened for an opportunity.",
"format": "date-time"
},
"trashedAt": {
"type": [
"string",
"null"
],
"description": "The date a prospect was soft deleted.",
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was last updated.",
"format": "date-time"
}
},
"additionalProperties": false
},
"relationships": {
"type": "object",
"properties": {
"account": {
"description": "The account the opportunity is for. You can use attributes id and name to filter opportunities 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
},
"assignedTeams": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"team"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"assignedUsers": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the opportunity. 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
},
"defaultPluginMapping": {
"description": "The default plugin mapping associated with the opportunity. If no plugin mapping is enabled, it will return the first plugin mapping associated with the opportunity.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"pluginMapping"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"externalCreator": {
"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 opportunity 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
},
"opportunityHealthFactors": {
"description": "The factors related to the opportunities health.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityHealthFactor"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunityLineItems": {
"description": "The products associated with opportunity.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityLineItem"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunityStage": {
"description": "The current stage of the opportunity. You can use only the attribute id to filter opportunities by stage (e.g. filter[stage][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityStage"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"owner": {
"description": "The user who owns the opportunity. You can use only the attribute id to filter opportunities 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
},
"primaryProspect": {
"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
},
"prospects": {
"description": "The prospects associated with this opportunity. You can use only the attribute id to filter opportunities by prospects (e.g. filter[prospects][id]=X).",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"stage": {
"description": "The current stage of the opportunity. You can use only the attribute id to filter opportunities by stage (e.g. filter[stage][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityStage"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"territory": {
"description": "The territory of the opportunity. You can use attributes id and name to filter opportunities by territory (e.g. filter[territory][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"territory"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updater": {
"description": "The updater of the opportunity. Relationship updater 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
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"opportunity"
]
}
},
"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": "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.",
"properties": {
"amount": {
"type": [
"integer",
"null"
],
"description": "The amount the opportunity is worth."
},
"amountPrecise": {
"type": [
"string",
"null"
],
"description": "The precise amount that the opportunity is worth.",
"maxLength": 15
},
"closeDate": {
"type": [
"string",
"null"
],
"description": "The date the opportunity is expected to close.",
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was created.",
"format": "date-time"
},
"currencyType": {
"type": [
"string",
"null"
],
"description": "The ISO code of the currency this opportunity is in.",
"maxLength": 255
},
"custom1": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's first custom field.",
"maxLength": 32000
},
"custom2": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's second custom field.",
"maxLength": 32000
},
"custom3": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's third custom field.",
"maxLength": 32000
},
"custom4": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's fourth custom field.",
"maxLength": 32000
},
"custom5": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's fifth custom field.",
"maxLength": 32000
},
"custom6": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's sixth custom field.",
"maxLength": 32000
},
"custom7": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's seventh custom field.",
"maxLength": 32000
},
"custom8": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's eighth custom field.",
"maxLength": 32000
},
"custom9": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's ninth custom field.",
"maxLength": 32000
},
"custom10": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 10th custom field.",
"maxLength": 32000
},
"custom11": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 11th custom field.",
"maxLength": 32000
},
"custom12": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 12th custom field.",
"maxLength": 32000
},
"custom13": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 13th custom field.",
"maxLength": 32000
},
"custom14": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 14th custom field.",
"maxLength": 32000
},
"custom15": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 15th custom field.",
"maxLength": 32000
},
"custom16": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 16th custom field.",
"maxLength": 32000
},
"custom17": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 17th custom field.",
"maxLength": 32000
},
"custom18": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 18th custom field.",
"maxLength": 32000
},
"custom19": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 19th custom field.",
"maxLength": 32000
},
"custom20": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 20th custom field.",
"maxLength": 32000
},
"custom21": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 21st custom field.",
"maxLength": 32000
},
"custom22": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 22nd custom field.",
"maxLength": 32000
},
"custom23": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 23rd custom field.",
"maxLength": 32000
},
"custom24": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 24th custom field.",
"maxLength": 32000
},
"custom25": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 25th custom field.",
"maxLength": 32000
},
"custom26": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 26th custom field.",
"maxLength": 32000
},
"custom27": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 27th custom field.",
"maxLength": 32000
},
"custom28": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 28th custom field.",
"maxLength": 32000
},
"custom29": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 29th custom field.",
"maxLength": 32000
},
"custom30": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 30th custom field.",
"maxLength": 32000
},
"custom31": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 31st custom field.",
"maxLength": 32000
},
"custom32": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 32nd custom field.",
"maxLength": 32000
},
"custom33": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 33rd custom field.",
"maxLength": 32000
},
"custom34": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 34th custom field.",
"maxLength": 32000
},
"custom35": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 35th custom field.",
"maxLength": 32000
},
"custom36": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 36th custom field.",
"maxLength": 32000
},
"custom37": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 37th custom field.",
"maxLength": 32000
},
"custom38": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 38th custom field.",
"maxLength": 32000
},
"custom39": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 39th custom field.",
"maxLength": 32000
},
"custom40": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 40th custom field.",
"maxLength": 32000
},
"custom41": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 41st custom field.",
"maxLength": 32000
},
"custom42": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 42nd custom field.",
"maxLength": 32000
},
"custom43": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 43rd custom field.",
"maxLength": 32000
},
"custom44": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 44th custom field.",
"maxLength": 32000
},
"custom45": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 45th custom field.",
"maxLength": 32000
},
"custom46": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 46th custom field.",
"maxLength": 32000
},
"custom47": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 47th custom field.",
"maxLength": 32000
},
"custom48": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 48th custom field.",
"maxLength": 32000
},
"custom49": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 49th custom field.",
"maxLength": 32000
},
"custom50": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 50th custom field.",
"maxLength": 32000
},
"custom51": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 51st custom field.",
"maxLength": 32000
},
"custom52": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 52nd custom field.",
"maxLength": 32000
},
"custom53": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 53rd custom field.",
"maxLength": 32000
},
"custom54": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 54th custom field.",
"maxLength": 32000
},
"custom55": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 55th custom field.",
"maxLength": 32000
},
"custom56": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 56th custom field.",
"maxLength": 32000
},
"custom57": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 57th custom field.",
"maxLength": 32000
},
"custom58": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 58th custom field.",
"maxLength": 32000
},
"custom59": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 59th custom field.",
"maxLength": 32000
},
"custom60": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 60th custom field.",
"maxLength": 32000
},
"custom61": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 61st custom field.",
"maxLength": 32000
},
"custom62": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 62nd custom field.",
"maxLength": 32000
},
"custom63": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 63rd custom field.",
"maxLength": 32000
},
"custom64": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 64th custom field.",
"maxLength": 32000
},
"custom65": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 65th custom field.",
"maxLength": 32000
},
"custom66": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 66th custom field.",
"maxLength": 32000
},
"custom67": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 67th custom field.",
"maxLength": 32000
},
"custom68": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 68th custom field.",
"maxLength": 32000
},
"custom69": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 69th custom field.",
"maxLength": 32000
},
"custom70": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 70th custom field.",
"maxLength": 32000
},
"custom71": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 71st custom field.",
"maxLength": 32000
},
"custom72": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 72nd custom field.",
"maxLength": 32000
},
"custom73": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 73rd custom field.",
"maxLength": 32000
},
"custom74": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 74th custom field.",
"maxLength": 32000
},
"custom75": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 75th custom field.",
"maxLength": 32000
},
"custom76": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 76th custom field.",
"maxLength": 32000
},
"custom77": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 77th custom field.",
"maxLength": 32000
},
"custom78": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 78th custom field.",
"maxLength": 32000
},
"custom79": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 79th custom field.",
"maxLength": 32000
},
"custom80": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 80th custom field.",
"maxLength": 32000
},
"custom81": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 81st custom field.",
"maxLength": 32000
},
"custom82": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 82nd custom field.",
"maxLength": 32000
},
"custom83": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 83rd custom field.",
"maxLength": 32000
},
"custom84": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 84th custom field.",
"maxLength": 32000
},
"custom85": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 85th custom field.",
"maxLength": 32000
},
"custom86": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 86th custom field.",
"maxLength": 32000
},
"custom87": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 87th custom field.",
"maxLength": 32000
},
"custom88": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 88th custom field.",
"maxLength": 32000
},
"custom89": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 89th custom field.",
"maxLength": 32000
},
"custom90": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 90th custom field.",
"maxLength": 32000
},
"custom91": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 91st custom field.",
"maxLength": 32000
},
"custom92": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 92nd custom field.",
"maxLength": 32000
},
"custom93": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 93rd custom field.",
"maxLength": 32000
},
"custom94": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 94th custom field.",
"maxLength": 32000
},
"custom95": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 95th custom field.",
"maxLength": 32000
},
"custom96": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 96th custom field.",
"maxLength": 32000
},
"custom97": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 97th custom field.",
"maxLength": 32000
},
"custom98": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 98th custom field.",
"maxLength": 32000
},
"custom99": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 99th custom field.",
"maxLength": 32000
},
"custom100": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity's 100th custom field.",
"maxLength": 32000
},
"custom101": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 101st custom field.",
"maxLength": 32000
},
"custom102": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 102nd custom field.",
"maxLength": 32000
},
"custom103": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 103rd custom field.",
"maxLength": 32000
},
"custom104": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 104th custom field.",
"maxLength": 32000
},
"custom105": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 105th custom field.",
"maxLength": 32000
},
"custom106": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 106th custom field.",
"maxLength": 32000
},
"custom107": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 107th custom field.",
"maxLength": 32000
},
"custom108": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 108th custom field.",
"maxLength": 32000
},
"custom109": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 109th custom field.",
"maxLength": 32000
},
"custom110": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 110th custom field.",
"maxLength": 32000
},
"custom111": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 111th custom field.",
"maxLength": 32000
},
"custom112": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 112th custom field.",
"maxLength": 32000
},
"custom113": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 113th custom field.",
"maxLength": 32000
},
"custom114": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 114th custom field.",
"maxLength": 32000
},
"custom115": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 115th custom field.",
"maxLength": 32000
},
"custom116": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 116th custom field.",
"maxLength": 32000
},
"custom117": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 117th custom field.",
"maxLength": 32000
},
"custom118": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 118th custom field.",
"maxLength": 32000
},
"custom119": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 119th custom field.",
"maxLength": 32000
},
"custom120": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 120th custom field.",
"maxLength": 32000
},
"custom121": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 121st custom field.",
"maxLength": 32000
},
"custom122": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 122nd custom field.",
"maxLength": 32000
},
"custom123": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 123rd custom field.",
"maxLength": 32000
},
"custom124": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 124th custom field.",
"maxLength": 32000
},
"custom125": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 125th custom field.",
"maxLength": 32000
},
"custom126": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 126th custom field.",
"maxLength": 32000
},
"custom127": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 127th custom field.",
"maxLength": 32000
},
"custom128": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 128th custom field.",
"maxLength": 32000
},
"custom129": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 129th custom field.",
"maxLength": 32000
},
"custom130": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 130th custom field.",
"maxLength": 32000
},
"custom131": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 131st custom field.",
"maxLength": 32000
},
"custom132": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 132nd custom field.",
"maxLength": 32000
},
"custom133": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 133rd custom field.",
"maxLength": 32000
},
"custom134": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 134th custom field.",
"maxLength": 32000
},
"custom135": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 135th custom field.",
"maxLength": 32000
},
"custom136": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 136th custom field.",
"maxLength": 32000
},
"custom137": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 137th custom field.",
"maxLength": 32000
},
"custom138": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 138th custom field.",
"maxLength": 32000
},
"custom139": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 139th custom field.",
"maxLength": 32000
},
"custom140": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 140th custom field.",
"maxLength": 32000
},
"custom141": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 141st custom field.",
"maxLength": 32000
},
"custom142": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 142nd custom field.",
"maxLength": 32000
},
"custom143": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 143rd custom field.",
"maxLength": 32000
},
"custom144": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 144th custom field.",
"maxLength": 32000
},
"custom145": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 145th custom field.",
"maxLength": 32000
},
"custom146": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 146th custom field.",
"maxLength": 32000
},
"custom147": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 147th custom field.",
"maxLength": 32000
},
"custom148": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 148th custom field.",
"maxLength": 32000
},
"custom149": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 149th custom field.",
"maxLength": 32000
},
"custom150": {
"type": [
"string",
"null"
],
"description": "The value of the opportunity’s 150th custom field.",
"maxLength": 32000
},
"customId": {
"type": [
"string",
"null"
],
"description": "A custom ID for the opportunity, often referencing an ID in an external system.",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
],
"description": "A description of the opportunity.",
"maxLength": 65535
},
"externalCreatedAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was created in the external system.",
"format": "date-time"
},
"externalUpdatedAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was last updated in the external system.",
"format": "date-time"
},
"forecastCategory": {
"type": [
"string",
"null"
],
"description": "The category or classification used to predict the likelihood of closing an opportunity.",
"maxLength": 32000
},
"leadSource": {
"type": [
"string",
"null"
],
"description": "Source of this opportunity, such as Advertisement or Trade Show",
"maxLength": 32000
},
"lostReason": {
"type": [
"string",
"null"
],
"description": "The reason why an opportunity or deal was lost.",
"maxLength": 32000
},
"mapLink": {
"type": [
"string",
"null"
],
"description": "A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.",
"maxLength": 255
},
"mapNextSteps": {
"type": [
"string",
"null"
],
"description": "The next event in the timeline that has yet to be completed for the SamePlan MAP (Mutual Action Plan).",
"maxLength": 255
},
"mapStatus": {
"type": [
"string",
"null"
],
"description": "The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.",
"maxLength": 255
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the opportunity.",
"maxLength": 255
},
"nextStep": {
"type": [
"string",
"null"
],
"description": "The next step to take for the opportunity.",
"maxLength": 65535
},
"opportunityType": {
"type": [
"string",
"null"
],
"description": "The type of opportunity.",
"maxLength": 255
},
"probability": {
"type": [
"integer",
"null"
],
"description": "The chances of the opportunity succeeding, represented as a percentage."
},
"prospectingRepId": {
"type": [
"string",
"null"
],
"description": "The ID of the sales rep that prospects the opportunity.",
"maxLength": 255
},
"recordType": {
"type": [
"string",
"null"
],
"description": "The type or category of the record, such as Opportunity, Lead, or Deal, used to classify and organize different stages in the sales process",
"maxLength": 32000
},
"sharingTeamId": {
"type": [
"string",
"null"
],
"description": "The ID of the sharing team associated with this object. Access is currently in beta.",
"maxLength": 255
},
"tags": {
"type": [
"array",
"null"
],
"description": "Tags associated with the opportunity.",
"items": {
"type": "string"
}
},
"touchedAt": {
"type": [
"string",
"null"
],
"description": "The last time an event happened for an opportunity.",
"format": "date-time"
},
"trashedAt": {
"type": [
"string",
"null"
],
"description": "The date a prospect was soft deleted.",
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date the opportunity was last updated.",
"format": "date-time"
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"account": {
"description": "The account the opportunity is for. You can use attributes id and name to filter opportunities 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
},
"assignedTeams": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"team"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"assignedUsers": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the opportunity. 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
},
"defaultPluginMapping": {
"description": "The default plugin mapping associated with the opportunity. If no plugin mapping is enabled, it will return the first plugin mapping associated with the opportunity.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"pluginMapping"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"externalCreator": {
"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 opportunity 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
},
"opportunityHealthFactors": {
"description": "The factors related to the opportunities health.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityHealthFactor"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunityLineItems": {
"description": "The products associated with opportunity.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityLineItem"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunityStage": {
"description": "The current stage of the opportunity. You can use only the attribute id to filter opportunities by stage (e.g. filter[stage][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityStage"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"owner": {
"description": "The user who owns the opportunity. You can use only the attribute id to filter opportunities 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
},
"primaryProspect": {
"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
},
"prospects": {
"description": "The prospects associated with this opportunity. You can use only the attribute id to filter opportunities by prospects (e.g. filter[prospects][id]=X).",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"stage": {
"description": "The current stage of the opportunity. You can use only the attribute id to filter opportunities by stage (e.g. filter[stage][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityStage"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"territory": {
"description": "The territory of the opportunity. You can use attributes id and name to filter opportunities by territory (e.g. filter[territory][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"territory"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updater": {
"description": "The updater of the opportunity. Relationship updater 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
}
},
"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_opportunity --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`.