> ## 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
> Update an Outreach prospect by ID. 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_update_prospect:{"id":"{{id}}","data":{}}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ----------------------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------- |
| `payload.id` | `integer` | Yes | | |
| `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]. |
| `payload.provideAuthorizationMeta` | `boolean` | No | | Request resource authorization metadata. |
| `payload.provideDataConnections` | `boolean` | No | | Request resource data-connection metadata. |
| `payload.actionParams_withUnnamedAccount` | `boolean` | No | | Send actionParams\[withUnnamedAccount] to control unnamed account relationships. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Update a Prospect",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "A descriptor of a person.",
"properties": {
"addedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was added to any system.",
"format": "date-time"
},
"addressCity": {
"type": [
"string",
"null"
],
"description": "The prospect’s city (e.g. \"Seattle\").",
"maxLength": 255
},
"addressCountry": {
"type": [
"string",
"null"
],
"description": "The prospect’s country (e.g. \"USA\").",
"maxLength": 255
},
"addressState": {
"type": [
"string",
"null"
],
"description": "The prospect’s state (e.g. \"Washington\").",
"maxLength": 255
},
"addressStreet": {
"type": [
"string",
"null"
],
"description": "The prospect’s street address (e.g. \"1441 N 34th St\").",
"maxLength": 255
},
"addressStreet2": {
"type": [
"string",
"null"
],
"description": "The prospect’s second street address, if applicable.",
"maxLength": 255
},
"addressZip": {
"type": [
"string",
"null"
],
"description": "The prospect’s postal code (e.g. \"98103\").",
"maxLength": 255
},
"angelListUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s AngelList URL.",
"maxLength": 255
},
"availableAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect is available to contact again.",
"format": "date-time"
},
"callOptedOut": {
"type": [
"boolean",
"null"
],
"description": "Whether the prospect is opted out of calling, or opted out in general if granular opt-out is not enabled."
},
"callsOptStatus": {
"type": [
"string",
"null"
],
"description": "A string (\"opted_in\", \"opted_out\", \"null\") that represents whether a prospect has opted into or out of calls.",
"maxLength": 255
},
"callsOptedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect opted in/out of calls.",
"format": "date-time"
},
"campaignName": {
"type": [
"string",
"null"
],
"description": "The name of the campaign the prospect is associated with.",
"maxLength": 255
},
"clickCount": {
"type": [
"integer",
"null"
],
"description": "The number of clicks the prospect has made since the last touch point."
},
"company": {
"type": [
"string",
"null"
],
"description": "The name of the company the prospect works at. If associated with an account, this is the name of the account. (e.g. Acme International)."
},
"contactHistogram": {
"type": [
"array",
"null"
],
"description": "The last 12 months of email contact history with the prospect, with the current month being the last element. The format for each month is '[inboundCount, outboundCount]'. Note: Retrieving this field will slow down the queries. Unless this field is required, it is best to filter it out. See Specify Sparse Fieldsets for examples",
"items": {
"format": "contact histogram"
}
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was created.",
"format": "date-time"
},
"custom1": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s first custom field.",
"maxLength": 32000
},
"custom2": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s second custom field.",
"maxLength": 32000
},
"custom3": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s third custom field.",
"maxLength": 32000
},
"custom4": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s fourth custom field.",
"maxLength": 32000
},
"custom5": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s fifth custom field.",
"maxLength": 32000
},
"custom6": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s sixth custom field.",
"maxLength": 32000
},
"custom7": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s seventh custom field.",
"maxLength": 32000
},
"custom8": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s eight custom field.",
"maxLength": 32000
},
"custom9": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s ninth custom field.",
"maxLength": 32000
},
"custom10": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 10th custom field.",
"maxLength": 32000
},
"custom11": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 11th custom field.",
"maxLength": 32000
},
"custom12": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 12th custom field.",
"maxLength": 32000
},
"custom13": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 13th custom field.",
"maxLength": 32000
},
"custom14": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 14th custom field.",
"maxLength": 32000
},
"custom15": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 15th custom field.",
"maxLength": 32000
},
"custom16": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 16th custom field.",
"maxLength": 32000
},
"custom17": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 17th custom field.",
"maxLength": 32000
},
"custom18": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 18th custom field.",
"maxLength": 32000
},
"custom19": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 19th custom field.",
"maxLength": 32000
},
"custom20": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 20th custom field.",
"maxLength": 32000
},
"custom21": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 21st custom field.",
"maxLength": 32000
},
"custom22": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 22nd custom field.",
"maxLength": 32000
},
"custom23": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 23rd custom field.",
"maxLength": 32000
},
"custom24": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 24th custom field.",
"maxLength": 32000
},
"custom25": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 25th custom field.",
"maxLength": 32000
},
"custom26": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 26th custom field.",
"maxLength": 32000
},
"custom27": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 27th custom field.",
"maxLength": 32000
},
"custom28": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 28th custom field.",
"maxLength": 32000
},
"custom29": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 29th custom field.",
"maxLength": 32000
},
"custom30": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 30th custom field.",
"maxLength": 32000
},
"custom31": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 31st custom field.",
"maxLength": 32000
},
"custom32": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 32nd custom field.",
"maxLength": 32000
},
"custom33": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 33rd custom field.",
"maxLength": 32000
},
"custom34": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 34th custom field.",
"maxLength": 32000
},
"custom35": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 35th custom field.",
"maxLength": 32000
},
"custom36": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 36th custom field.",
"maxLength": 32000
},
"custom37": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 37th custom field.",
"maxLength": 32000
},
"custom38": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 38th custom field.",
"maxLength": 32000
},
"custom39": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 39th custom field.",
"maxLength": 32000
},
"custom40": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 40th custom field.",
"maxLength": 32000
},
"custom41": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 41st custom field.",
"maxLength": 32000
},
"custom42": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 42nd custom field.",
"maxLength": 32000
},
"custom43": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 43rd custom field.",
"maxLength": 32000
},
"custom44": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 44th custom field.",
"maxLength": 32000
},
"custom45": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 45th custom field.",
"maxLength": 32000
},
"custom46": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 46th custom field.",
"maxLength": 32000
},
"custom47": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 47th custom field.",
"maxLength": 32000
},
"custom48": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 48th custom field.",
"maxLength": 32000
},
"custom49": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 49th custom field.",
"maxLength": 32000
},
"custom50": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 50th custom field.",
"maxLength": 32000
},
"custom51": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 51st custom field.",
"maxLength": 32000
},
"custom52": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 52nd custom field.",
"maxLength": 32000
},
"custom53": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 53rd custom field.",
"maxLength": 32000
},
"custom54": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 54th custom field.",
"maxLength": 32000
},
"custom55": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 55th custom field.",
"maxLength": 32000
},
"custom56": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 56th custom field.",
"maxLength": 32000
},
"custom57": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 57th custom field.",
"maxLength": 32000
},
"custom58": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 58th custom field.",
"maxLength": 32000
},
"custom59": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 59th custom field.",
"maxLength": 32000
},
"custom60": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 60th custom field.",
"maxLength": 32000
},
"custom61": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 61st custom field.",
"maxLength": 32000
},
"custom62": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 62nd custom field.",
"maxLength": 32000
},
"custom63": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 63rd custom field.",
"maxLength": 32000
},
"custom64": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 64th custom field.",
"maxLength": 32000
},
"custom65": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 65th custom field.",
"maxLength": 32000
},
"custom66": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 66th custom field.",
"maxLength": 32000
},
"custom67": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 67th custom field.",
"maxLength": 32000
},
"custom68": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 68th custom field.",
"maxLength": 32000
},
"custom69": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 69th custom field.",
"maxLength": 32000
},
"custom70": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 70th custom field.",
"maxLength": 32000
},
"custom71": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 71st custom field.",
"maxLength": 32000
},
"custom72": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 72nd custom field.",
"maxLength": 32000
},
"custom73": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 73rd custom field.",
"maxLength": 32000
},
"custom74": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 74th custom field.",
"maxLength": 32000
},
"custom75": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 75th custom field.",
"maxLength": 32000
},
"custom76": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 76th custom field.",
"maxLength": 32000
},
"custom77": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 77th custom field.",
"maxLength": 32000
},
"custom78": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 78th custom field.",
"maxLength": 32000
},
"custom79": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 79th custom field.",
"maxLength": 32000
},
"custom80": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 80th custom field.",
"maxLength": 32000
},
"custom81": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 81st custom field.",
"maxLength": 32000
},
"custom82": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 82nd custom field.",
"maxLength": 32000
},
"custom83": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 83rd custom field.",
"maxLength": 32000
},
"custom84": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 84th custom field.",
"maxLength": 32000
},
"custom85": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 85th custom field.",
"maxLength": 32000
},
"custom86": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 86th custom field.",
"maxLength": 32000
},
"custom87": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 87th custom field.",
"maxLength": 32000
},
"custom88": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 88th custom field.",
"maxLength": 32000
},
"custom89": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 89th custom field.",
"maxLength": 32000
},
"custom90": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 90th custom field.",
"maxLength": 32000
},
"custom91": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 91st custom field.",
"maxLength": 32000
},
"custom92": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 92nd custom field.",
"maxLength": 32000
},
"custom93": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 93rd custom field.",
"maxLength": 32000
},
"custom94": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 94th custom field.",
"maxLength": 32000
},
"custom95": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 95th custom field.",
"maxLength": 32000
},
"custom96": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 96th custom field.",
"maxLength": 32000
},
"custom97": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 97th custom field.",
"maxLength": 32000
},
"custom98": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 98th custom field.",
"maxLength": 32000
},
"custom99": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 99th custom field.",
"maxLength": 32000
},
"custom100": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 100th custom field.",
"maxLength": 32000
},
"custom101": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 101st custom field.",
"maxLength": 32000
},
"custom102": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 102nd custom field.",
"maxLength": 32000
},
"custom103": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 103rd custom field.",
"maxLength": 32000
},
"custom104": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 104th custom field.",
"maxLength": 32000
},
"custom105": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 105th custom field.",
"maxLength": 32000
},
"custom106": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 106th custom field.",
"maxLength": 32000
},
"custom107": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 107th custom field.",
"maxLength": 32000
},
"custom108": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 108th custom field.",
"maxLength": 32000
},
"custom109": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 109th custom field.",
"maxLength": 32000
},
"custom110": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 110th custom field.",
"maxLength": 32000
},
"custom111": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 111th custom field.",
"maxLength": 32000
},
"custom112": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 112th custom field.",
"maxLength": 32000
},
"custom113": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 113th custom field.",
"maxLength": 32000
},
"custom114": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 114th custom field.",
"maxLength": 32000
},
"custom115": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 115th custom field.",
"maxLength": 32000
},
"custom116": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 116th custom field.",
"maxLength": 32000
},
"custom117": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 117th custom field.",
"maxLength": 32000
},
"custom118": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 118th custom field.",
"maxLength": 32000
},
"custom119": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 119th custom field.",
"maxLength": 32000
},
"custom120": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 120th custom field.",
"maxLength": 32000
},
"custom121": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 121st custom field.",
"maxLength": 32000
},
"custom122": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 122nd custom field.",
"maxLength": 32000
},
"custom123": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 123rd custom field.",
"maxLength": 32000
},
"custom124": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 124th custom field.",
"maxLength": 32000
},
"custom125": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 125th custom field.",
"maxLength": 32000
},
"custom126": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 126th custom field.",
"maxLength": 32000
},
"custom127": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 127th custom field.",
"maxLength": 32000
},
"custom128": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 128th custom field.",
"maxLength": 32000
},
"custom129": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 129th custom field.",
"maxLength": 32000
},
"custom130": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 130th custom field.",
"maxLength": 32000
},
"custom131": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 131st custom field.",
"maxLength": 32000
},
"custom132": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 132nd custom field.",
"maxLength": 32000
},
"custom133": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 133rd custom field.",
"maxLength": 32000
},
"custom134": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 134th custom field.",
"maxLength": 32000
},
"custom135": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 135th custom field.",
"maxLength": 32000
},
"custom136": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 136th custom field.",
"maxLength": 32000
},
"custom137": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 137th custom field.",
"maxLength": 32000
},
"custom138": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 138th custom field.",
"maxLength": 32000
},
"custom139": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 139th custom field.",
"maxLength": 32000
},
"custom140": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 140th custom field.",
"maxLength": 32000
},
"custom141": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 141st custom field.",
"maxLength": 32000
},
"custom142": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 142nd custom field.",
"maxLength": 32000
},
"custom143": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 143rd custom field.",
"maxLength": 32000
},
"custom144": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 144th custom field.",
"maxLength": 32000
},
"custom145": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 145th custom field.",
"maxLength": 32000
},
"custom146": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 146th custom field.",
"maxLength": 32000
},
"custom147": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 147th custom field.",
"maxLength": 32000
},
"custom148": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 148th custom field.",
"maxLength": 32000
},
"custom149": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 149th custom field.",
"maxLength": 32000
},
"custom150": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 150th custom field.",
"maxLength": 32000
},
"dateOfBirth": {
"type": [
"string",
"null"
],
"description": "The date the prospect was born.",
"format": "date"
},
"degree": {
"type": [
"string",
"null"
],
"description": "The degree(s) the prospect has received.",
"maxLength": 255
},
"emailOptedOut": {
"type": [
"boolean",
"null"
],
"description": "Whether the prospect is opted out of email, or opted out in general if granular opt-out is not enabled."
},
"emails": {
"type": [
"array",
"null"
],
"description": "A list of email addresses associated with the prospect.",
"items": {
"type": "string",
"format": "email"
}
},
"emailsOptStatus": {
"type": [
"string",
"null"
],
"description": "A string (\"opted_in\", \"opted_out\", \"null\") that represents whether a prospect has opted into or out of emails.",
"maxLength": 255
},
"emailsOptedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect opted in/out of emails.",
"format": "date-time"
},
"engagedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect last engaged.",
"format": "date-time"
},
"engagedScore": {
"type": [
"number",
"null"
],
"description": "A number representing the quality of the lead, based on the number of the prospect’s opens, clicks and mailing replies.",
"format": "float"
},
"eventName": {
"type": [
"string",
"null"
],
"description": "The name of the event the prospect was met at.",
"maxLength": 255
},
"externalId": {
"type": [
"string",
"null"
],
"description": "A custom ID for the prospect, often referencing an ID in an external system.",
"maxLength": 255
},
"externalOwner": {
"type": [
"string",
"null"
],
"description": "A custom owner for the prospect, often referencing an ownering in an external system.",
"maxLength": 255
},
"externalSource": {
"type": [
"string",
"null"
],
"description": "The source of the resource’s creation (e.g. \"outreach-api\").",
"maxLength": 255
},
"facebookUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Facebook URL.",
"maxLength": 255
},
"firstName": {
"type": [
"string",
"null"
],
"description": "The first name of the prospect.",
"maxLength": 255
},
"gender": {
"type": [
"string",
"null"
],
"description": "The gender of the prospect.",
"maxLength": 255
},
"githubUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s GitHub URL.",
"maxLength": 1000
},
"githubUsername": {
"type": [
"string",
"null"
],
"description": "The prospect’s GitHub username.",
"maxLength": 255
},
"googlePlusUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Google+ URL.",
"maxLength": 255
},
"graduationDate": {
"type": [
"string",
"null"
],
"description": "The graduation date of the prospect.",
"format": "date"
},
"homePhones": {
"type": [
"array",
"null"
],
"description": "A list of home phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"jobStartDate": {
"type": [
"string",
"null"
],
"description": "The starting date of the prospect’s current job.",
"format": "date"
},
"lastName": {
"type": [
"string",
"null"
],
"description": "The last name of the prospect.",
"maxLength": 255
},
"linkedInConnections": {
"type": [
"integer",
"null"
],
"description": "The number of connections on the prospect’s LinkedIn profile."
},
"linkedInId": {
"type": [
"string",
"null"
],
"description": "The prospect’s LinkedIn ID.",
"maxLength": 255
},
"linkedInSlug": {
"type": [
"string",
"null"
],
"description": "The prospect’s LinkedIn slug.",
"maxLength": 255
},
"linkedInUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s LinkedIn URL.",
"maxLength": 1000
},
"middleName": {
"type": [
"string",
"null"
],
"description": "The middle name of the prospect.",
"maxLength": 255
},
"mobilePhones": {
"type": [
"array",
"null"
],
"description": "A list of mobile phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"name": {
"type": [
"string",
"null"
],
"description": "The full name of the prospect."
},
"nickname": {
"type": [
"string",
"null"
],
"description": "The nickname of the prospect.",
"maxLength": 255
},
"occupation": {
"type": [
"string",
"null"
],
"description": "The occupation of the prospect (e.g. \"Purchasing Manager\").",
"maxLength": 255
},
"openCount": {
"type": [
"integer",
"null"
],
"description": "The number of opens the prospect has made since the last touch point."
},
"optedOut": {
"type": [
"boolean",
"null"
],
"description": "A boolean value representing whether this prospect is currently opted out of all mailings. Set this value to true to opt out the prospect; the 'opted_out' timestamp will be updated to the time of the request. Set this value to false to revert the opt at and clear the opted out timestamp."
},
"optedOutAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect opted out of emails.",
"format": "date-time"
},
"otherPhones": {
"type": [
"array",
"null"
],
"description": "A list of other phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"personalNote1": {
"type": [
"string",
"null"
],
"description": "A custom note field related to the prospect.",
"maxLength": 65535
},
"personalNote2": {
"type": [
"string",
"null"
],
"description": "A second note field related to the prospect.",
"maxLength": 65535
},
"preferredContact": {
"type": [
"string",
"null"
],
"description": "The preferred contact method for the prospect.",
"maxLength": 255
},
"quoraUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Quora URL.",
"maxLength": 255
},
"region": {
"type": [
"string",
"null"
],
"description": "The primary geographic region of the prospect.",
"maxLength": 255
},
"replyCount": {
"type": [
"integer",
"null"
],
"description": "The number of replies the prospect has made since the last touch point."
},
"school": {
"type": [
"string",
"null"
],
"description": "The school(s) the prospect has attended.",
"maxLength": 255
},
"score": {
"type": [
"number",
"null"
],
"description": "A custom score given to measure the quality of the lead.",
"format": "float"
},
"sharingTeamId": {
"type": [
"string",
"null"
],
"description": "The ID of the sharing team associated with this object. Access is currently in beta.",
"maxLength": 255
},
"source": {
"type": [
"string",
"null"
],
"description": "A custom source representing where the lead was first acquired.",
"maxLength": 255
},
"specialties": {
"type": [
"string",
"null"
],
"description": "A description of the prospect’s specialties.",
"maxLength": 65535
},
"stackOverflowId": {
"type": [
"string",
"null"
],
"description": "The prospect’s StackOverflow ID.",
"maxLength": 255
},
"stackOverflowUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s StackOverflow URL.",
"maxLength": 1000
},
"tags": {
"type": [
"array",
"null"
],
"description": "A list of tag values associated with the account (e.g. [\"Interested\", \"2017 Expo\"]).",
"items": {
"type": "string"
}
},
"timeZone": {
"type": [
"string",
"null"
],
"description": "The prospect’s current timezone, preferably in the IANA format (e.g. \"America/LosAngeles\").",
"maxLength": 255
},
"timeZoneIana": {
"type": [
"string",
"null"
],
"description": "The prospect’s current IANA timezone, if available."
},
"timeZoneInferred": {
"type": [
"string",
"null"
],
"description": "The prospect’s current inferred IANA timezone, if available.",
"maxLength": 255
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the prospect.",
"maxLength": 255
},
"touchedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was last touched.",
"format": "date-time"
},
"trashedAt": {
"type": [
"string",
"null"
],
"description": "The date a prospect was soft deleted.",
"format": "date-time"
},
"twitterUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Twitter URL.",
"maxLength": 1000
},
"twitterUsername": {
"type": [
"string",
"null"
],
"description": "The prospect’s Twitter username.",
"maxLength": 255
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was last updated.",
"format": "date-time"
},
"voipPhones": {
"type": [
"array",
"null"
],
"description": "A list of voip phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"websiteUrl1": {
"type": [
"string",
"null"
],
"description": "The URL of the prospect’s website.",
"maxLength": 65535
},
"websiteUrl2": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s second website URL field.",
"maxLength": 65535
},
"websiteUrl3": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s third website URL field.",
"maxLength": 65535
},
"workPhones": {
"type": [
"array",
"null"
],
"description": "A list of work phone numbers associated with the prospect.",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"account": {
"description": "The prospect's associated account. You can use attributes id, customId, name, named and updatedAt to filter prospects by account (e.g. filter[account][id]=X). You can force a null return on unnamed account by adding in the request actionParams[withUnnamedAccount]=false.",
"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
},
"activeSequenceStates": {
"description": "The non-finished sequence states where this prospect is the primary recipient. This includes states of \"active\", \"paused\", \"failed\", \"bounced\", \"pending\" and \"disabled.\" You can use attributes id and state to filter prospects by activeSequenceStates (e.g. filter[activeSequenceStates][id]=X).",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"sequenceState"
]
}
},
"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
},
"batches": {
"description": "The batches associated with the prospect.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"calls": {
"description": "The calls associated with the prospect. Relationship calls cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creater of the prospect. 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 prospect. If no plugin mapping is enabled, it will return the first plugin mapping associated with the prospect.",
"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
},
"emailAddresses": {
"description": "The prospect's email addresses. Relationship emailAddresses cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"emailAddress"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"favorites": {
"description": "The prospect's favorites. Relationship favorites cannot be used as a filter.",
"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
},
"mailings": {
"description": "The mailings associated with the prospect. Relationship mailings cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunities": {
"description": "The opportunities associated with the prospect. Requires the Opportunities SKU to be enabled in order to have access. Please contact support@outreach.io for more assistance. You can use only the attribute id to filter prospects by opportunities (e.g. filter[opportunities][id]=X).",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunity"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunityProspectRoles": {
"description": "The roles that associate the prospect with opportunities. Relationship opportunityProspectRoles cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityProspectRole"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"owner": {
"description": "The owner of the prospect. You can use only the attribute id to filter prospects 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
},
"persona": {
"description": "The persona of the prospect, if it has one. You can use only the attribute id to filter prospects by persona (e.g. filter[persona][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"persona"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"phoneNumbers": {
"description": "The prospect's phone numbers Relationship phoneNumbers cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"phoneNumber"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"sequenceStates": {
"description": "The sequence states where this prospect is the primary recipient. You can use attributes id and state to filter prospects by sequenceStates (e.g. filter[sequenceStates][id]=X).",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"stage": {
"description": "The stage the prospect is in. You can use attributes id and name to filter prospects by stage (e.g. filter[stage][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"stage"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"tasks": {
"description": "The tasks associated with the prospect. Relationship tasks cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"trashedByAccount": {
"description": "The account that soft deleted this prospect.",
"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
},
"updater": {
"description": "The most recent updater of the prospect. 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": [
"prospect"
]
}
},
"required": [
"type",
"id"
],
"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
},
"provideAuthorizationMeta": {
"type": "boolean",
"description": "Request resource authorization metadata."
},
"provideDataConnections": {
"type": "boolean",
"description": "Request resource data-connection metadata."
},
"actionParams_withUnnamedAccount": {
"type": "boolean",
"description": "Send actionParams[withUnnamedAccount] to control unnamed account relationships."
}
},
"required": [
"id",
"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": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"data": {
"properties": {
"attributes": {
"type": "object",
"description": "A descriptor of a person.",
"properties": {
"addedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was added to any system.",
"format": "date-time"
},
"addressCity": {
"type": [
"string",
"null"
],
"description": "The prospect’s city (e.g. \"Seattle\").",
"maxLength": 255
},
"addressCountry": {
"type": [
"string",
"null"
],
"description": "The prospect’s country (e.g. \"USA\").",
"maxLength": 255
},
"addressState": {
"type": [
"string",
"null"
],
"description": "The prospect’s state (e.g. \"Washington\").",
"maxLength": 255
},
"addressStreet": {
"type": [
"string",
"null"
],
"description": "The prospect’s street address (e.g. \"1441 N 34th St\").",
"maxLength": 255
},
"addressStreet2": {
"type": [
"string",
"null"
],
"description": "The prospect’s second street address, if applicable.",
"maxLength": 255
},
"addressZip": {
"type": [
"string",
"null"
],
"description": "The prospect’s postal code (e.g. \"98103\").",
"maxLength": 255
},
"angelListUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s AngelList URL.",
"maxLength": 255
},
"availableAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect is available to contact again.",
"format": "date-time"
},
"callOptedOut": {
"type": [
"boolean",
"null"
],
"description": "Whether the prospect is opted out of calling, or opted out in general if granular opt-out is not enabled."
},
"callsOptStatus": {
"type": [
"string",
"null"
],
"description": "A string (\"opted_in\", \"opted_out\", \"null\") that represents whether a prospect has opted into or out of calls.",
"maxLength": 255
},
"callsOptedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect opted in/out of calls.",
"format": "date-time"
},
"campaignName": {
"type": [
"string",
"null"
],
"description": "The name of the campaign the prospect is associated with.",
"maxLength": 255
},
"clickCount": {
"type": [
"integer",
"null"
],
"description": "The number of clicks the prospect has made since the last touch point."
},
"company": {
"type": [
"string",
"null"
],
"description": "The name of the company the prospect works at. If associated with an account, this is the name of the account. (e.g. Acme International)."
},
"contactHistogram": {
"type": [
"array",
"null"
],
"description": "The last 12 months of email contact history with the prospect, with the current month being the last element. The format for each month is '[inboundCount, outboundCount]'. Note: Retrieving this field will slow down the queries. Unless this field is required, it is best to filter it out. See Specify Sparse Fieldsets for examples",
"items": {
"format": "contact histogram"
}
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was created.",
"format": "date-time"
},
"custom1": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s first custom field.",
"maxLength": 32000
},
"custom2": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s second custom field.",
"maxLength": 32000
},
"custom3": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s third custom field.",
"maxLength": 32000
},
"custom4": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s fourth custom field.",
"maxLength": 32000
},
"custom5": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s fifth custom field.",
"maxLength": 32000
},
"custom6": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s sixth custom field.",
"maxLength": 32000
},
"custom7": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s seventh custom field.",
"maxLength": 32000
},
"custom8": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s eight custom field.",
"maxLength": 32000
},
"custom9": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s ninth custom field.",
"maxLength": 32000
},
"custom10": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 10th custom field.",
"maxLength": 32000
},
"custom11": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 11th custom field.",
"maxLength": 32000
},
"custom12": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 12th custom field.",
"maxLength": 32000
},
"custom13": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 13th custom field.",
"maxLength": 32000
},
"custom14": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 14th custom field.",
"maxLength": 32000
},
"custom15": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 15th custom field.",
"maxLength": 32000
},
"custom16": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 16th custom field.",
"maxLength": 32000
},
"custom17": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 17th custom field.",
"maxLength": 32000
},
"custom18": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 18th custom field.",
"maxLength": 32000
},
"custom19": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 19th custom field.",
"maxLength": 32000
},
"custom20": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 20th custom field.",
"maxLength": 32000
},
"custom21": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 21st custom field.",
"maxLength": 32000
},
"custom22": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 22nd custom field.",
"maxLength": 32000
},
"custom23": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 23rd custom field.",
"maxLength": 32000
},
"custom24": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 24th custom field.",
"maxLength": 32000
},
"custom25": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 25th custom field.",
"maxLength": 32000
},
"custom26": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 26th custom field.",
"maxLength": 32000
},
"custom27": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 27th custom field.",
"maxLength": 32000
},
"custom28": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 28th custom field.",
"maxLength": 32000
},
"custom29": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 29th custom field.",
"maxLength": 32000
},
"custom30": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 30th custom field.",
"maxLength": 32000
},
"custom31": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 31st custom field.",
"maxLength": 32000
},
"custom32": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 32nd custom field.",
"maxLength": 32000
},
"custom33": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 33rd custom field.",
"maxLength": 32000
},
"custom34": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 34th custom field.",
"maxLength": 32000
},
"custom35": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 35th custom field.",
"maxLength": 32000
},
"custom36": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 36th custom field.",
"maxLength": 32000
},
"custom37": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 37th custom field.",
"maxLength": 32000
},
"custom38": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 38th custom field.",
"maxLength": 32000
},
"custom39": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 39th custom field.",
"maxLength": 32000
},
"custom40": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 40th custom field.",
"maxLength": 32000
},
"custom41": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 41st custom field.",
"maxLength": 32000
},
"custom42": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 42nd custom field.",
"maxLength": 32000
},
"custom43": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 43rd custom field.",
"maxLength": 32000
},
"custom44": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 44th custom field.",
"maxLength": 32000
},
"custom45": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 45th custom field.",
"maxLength": 32000
},
"custom46": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 46th custom field.",
"maxLength": 32000
},
"custom47": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 47th custom field.",
"maxLength": 32000
},
"custom48": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 48th custom field.",
"maxLength": 32000
},
"custom49": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 49th custom field.",
"maxLength": 32000
},
"custom50": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 50th custom field.",
"maxLength": 32000
},
"custom51": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 51st custom field.",
"maxLength": 32000
},
"custom52": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 52nd custom field.",
"maxLength": 32000
},
"custom53": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 53rd custom field.",
"maxLength": 32000
},
"custom54": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 54th custom field.",
"maxLength": 32000
},
"custom55": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 55th custom field.",
"maxLength": 32000
},
"custom56": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 56th custom field.",
"maxLength": 32000
},
"custom57": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 57th custom field.",
"maxLength": 32000
},
"custom58": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 58th custom field.",
"maxLength": 32000
},
"custom59": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 59th custom field.",
"maxLength": 32000
},
"custom60": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 60th custom field.",
"maxLength": 32000
},
"custom61": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 61st custom field.",
"maxLength": 32000
},
"custom62": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 62nd custom field.",
"maxLength": 32000
},
"custom63": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 63rd custom field.",
"maxLength": 32000
},
"custom64": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 64th custom field.",
"maxLength": 32000
},
"custom65": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 65th custom field.",
"maxLength": 32000
},
"custom66": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 66th custom field.",
"maxLength": 32000
},
"custom67": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 67th custom field.",
"maxLength": 32000
},
"custom68": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 68th custom field.",
"maxLength": 32000
},
"custom69": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 69th custom field.",
"maxLength": 32000
},
"custom70": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 70th custom field.",
"maxLength": 32000
},
"custom71": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 71st custom field.",
"maxLength": 32000
},
"custom72": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 72nd custom field.",
"maxLength": 32000
},
"custom73": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 73rd custom field.",
"maxLength": 32000
},
"custom74": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 74th custom field.",
"maxLength": 32000
},
"custom75": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 75th custom field.",
"maxLength": 32000
},
"custom76": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 76th custom field.",
"maxLength": 32000
},
"custom77": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 77th custom field.",
"maxLength": 32000
},
"custom78": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 78th custom field.",
"maxLength": 32000
},
"custom79": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 79th custom field.",
"maxLength": 32000
},
"custom80": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 80th custom field.",
"maxLength": 32000
},
"custom81": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 81st custom field.",
"maxLength": 32000
},
"custom82": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 82nd custom field.",
"maxLength": 32000
},
"custom83": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 83rd custom field.",
"maxLength": 32000
},
"custom84": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 84th custom field.",
"maxLength": 32000
},
"custom85": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 85th custom field.",
"maxLength": 32000
},
"custom86": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 86th custom field.",
"maxLength": 32000
},
"custom87": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 87th custom field.",
"maxLength": 32000
},
"custom88": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 88th custom field.",
"maxLength": 32000
},
"custom89": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 89th custom field.",
"maxLength": 32000
},
"custom90": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 90th custom field.",
"maxLength": 32000
},
"custom91": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 91st custom field.",
"maxLength": 32000
},
"custom92": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 92nd custom field.",
"maxLength": 32000
},
"custom93": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 93rd custom field.",
"maxLength": 32000
},
"custom94": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 94th custom field.",
"maxLength": 32000
},
"custom95": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 95th custom field.",
"maxLength": 32000
},
"custom96": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 96th custom field.",
"maxLength": 32000
},
"custom97": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 97th custom field.",
"maxLength": 32000
},
"custom98": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 98th custom field.",
"maxLength": 32000
},
"custom99": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 99th custom field.",
"maxLength": 32000
},
"custom100": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 100th custom field.",
"maxLength": 32000
},
"custom101": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 101st custom field.",
"maxLength": 32000
},
"custom102": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 102nd custom field.",
"maxLength": 32000
},
"custom103": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 103rd custom field.",
"maxLength": 32000
},
"custom104": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 104th custom field.",
"maxLength": 32000
},
"custom105": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 105th custom field.",
"maxLength": 32000
},
"custom106": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 106th custom field.",
"maxLength": 32000
},
"custom107": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 107th custom field.",
"maxLength": 32000
},
"custom108": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 108th custom field.",
"maxLength": 32000
},
"custom109": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 109th custom field.",
"maxLength": 32000
},
"custom110": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 110th custom field.",
"maxLength": 32000
},
"custom111": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 111th custom field.",
"maxLength": 32000
},
"custom112": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 112th custom field.",
"maxLength": 32000
},
"custom113": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 113th custom field.",
"maxLength": 32000
},
"custom114": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 114th custom field.",
"maxLength": 32000
},
"custom115": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 115th custom field.",
"maxLength": 32000
},
"custom116": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 116th custom field.",
"maxLength": 32000
},
"custom117": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 117th custom field.",
"maxLength": 32000
},
"custom118": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 118th custom field.",
"maxLength": 32000
},
"custom119": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 119th custom field.",
"maxLength": 32000
},
"custom120": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 120th custom field.",
"maxLength": 32000
},
"custom121": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 121st custom field.",
"maxLength": 32000
},
"custom122": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 122nd custom field.",
"maxLength": 32000
},
"custom123": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 123rd custom field.",
"maxLength": 32000
},
"custom124": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 124th custom field.",
"maxLength": 32000
},
"custom125": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 125th custom field.",
"maxLength": 32000
},
"custom126": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 126th custom field.",
"maxLength": 32000
},
"custom127": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 127th custom field.",
"maxLength": 32000
},
"custom128": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 128th custom field.",
"maxLength": 32000
},
"custom129": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 129th custom field.",
"maxLength": 32000
},
"custom130": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 130th custom field.",
"maxLength": 32000
},
"custom131": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 131st custom field.",
"maxLength": 32000
},
"custom132": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 132nd custom field.",
"maxLength": 32000
},
"custom133": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 133rd custom field.",
"maxLength": 32000
},
"custom134": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 134th custom field.",
"maxLength": 32000
},
"custom135": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 135th custom field.",
"maxLength": 32000
},
"custom136": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 136th custom field.",
"maxLength": 32000
},
"custom137": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 137th custom field.",
"maxLength": 32000
},
"custom138": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 138th custom field.",
"maxLength": 32000
},
"custom139": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 139th custom field.",
"maxLength": 32000
},
"custom140": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 140th custom field.",
"maxLength": 32000
},
"custom141": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 141st custom field.",
"maxLength": 32000
},
"custom142": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 142nd custom field.",
"maxLength": 32000
},
"custom143": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 143rd custom field.",
"maxLength": 32000
},
"custom144": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 144th custom field.",
"maxLength": 32000
},
"custom145": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 145th custom field.",
"maxLength": 32000
},
"custom146": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 146th custom field.",
"maxLength": 32000
},
"custom147": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 147th custom field.",
"maxLength": 32000
},
"custom148": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 148th custom field.",
"maxLength": 32000
},
"custom149": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 149th custom field.",
"maxLength": 32000
},
"custom150": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s 150th custom field.",
"maxLength": 32000
},
"dateOfBirth": {
"type": [
"string",
"null"
],
"description": "The date the prospect was born.",
"format": "date"
},
"degree": {
"type": [
"string",
"null"
],
"description": "The degree(s) the prospect has received.",
"maxLength": 255
},
"emailOptedOut": {
"type": [
"boolean",
"null"
],
"description": "Whether the prospect is opted out of email, or opted out in general if granular opt-out is not enabled."
},
"emails": {
"type": [
"array",
"null"
],
"description": "A list of email addresses associated with the prospect.",
"items": {
"type": "string",
"format": "email"
}
},
"emailsOptStatus": {
"type": [
"string",
"null"
],
"description": "A string (\"opted_in\", \"opted_out\", \"null\") that represents whether a prospect has opted into or out of emails.",
"maxLength": 255
},
"emailsOptedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect opted in/out of emails.",
"format": "date-time"
},
"engagedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect last engaged.",
"format": "date-time"
},
"engagedScore": {
"type": [
"number",
"null"
],
"description": "A number representing the quality of the lead, based on the number of the prospect’s opens, clicks and mailing replies.",
"format": "float"
},
"eventName": {
"type": [
"string",
"null"
],
"description": "The name of the event the prospect was met at.",
"maxLength": 255
},
"externalId": {
"type": [
"string",
"null"
],
"description": "A custom ID for the prospect, often referencing an ID in an external system.",
"maxLength": 255
},
"externalOwner": {
"type": [
"string",
"null"
],
"description": "A custom owner for the prospect, often referencing an ownering in an external system.",
"maxLength": 255
},
"externalSource": {
"type": [
"string",
"null"
],
"description": "The source of the resource’s creation (e.g. \"outreach-api\").",
"maxLength": 255
},
"facebookUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Facebook URL.",
"maxLength": 255
},
"firstName": {
"type": [
"string",
"null"
],
"description": "The first name of the prospect.",
"maxLength": 255
},
"gender": {
"type": [
"string",
"null"
],
"description": "The gender of the prospect.",
"maxLength": 255
},
"githubUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s GitHub URL.",
"maxLength": 1000
},
"githubUsername": {
"type": [
"string",
"null"
],
"description": "The prospect’s GitHub username.",
"maxLength": 255
},
"googlePlusUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Google+ URL.",
"maxLength": 255
},
"graduationDate": {
"type": [
"string",
"null"
],
"description": "The graduation date of the prospect.",
"format": "date"
},
"homePhones": {
"type": [
"array",
"null"
],
"description": "A list of home phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"jobStartDate": {
"type": [
"string",
"null"
],
"description": "The starting date of the prospect’s current job.",
"format": "date"
},
"lastName": {
"type": [
"string",
"null"
],
"description": "The last name of the prospect.",
"maxLength": 255
},
"linkedInConnections": {
"type": [
"integer",
"null"
],
"description": "The number of connections on the prospect’s LinkedIn profile."
},
"linkedInId": {
"type": [
"string",
"null"
],
"description": "The prospect’s LinkedIn ID.",
"maxLength": 255
},
"linkedInSlug": {
"type": [
"string",
"null"
],
"description": "The prospect’s LinkedIn slug.",
"maxLength": 255
},
"linkedInUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s LinkedIn URL.",
"maxLength": 1000
},
"middleName": {
"type": [
"string",
"null"
],
"description": "The middle name of the prospect.",
"maxLength": 255
},
"mobilePhones": {
"type": [
"array",
"null"
],
"description": "A list of mobile phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"name": {
"type": [
"string",
"null"
],
"description": "The full name of the prospect."
},
"nickname": {
"type": [
"string",
"null"
],
"description": "The nickname of the prospect.",
"maxLength": 255
},
"occupation": {
"type": [
"string",
"null"
],
"description": "The occupation of the prospect (e.g. \"Purchasing Manager\").",
"maxLength": 255
},
"openCount": {
"type": [
"integer",
"null"
],
"description": "The number of opens the prospect has made since the last touch point."
},
"optedOut": {
"type": [
"boolean",
"null"
],
"description": "A boolean value representing whether this prospect is currently opted out of all mailings. Set this value to true to opt out the prospect; the 'opted_out' timestamp will be updated to the time of the request. Set this value to false to revert the opt at and clear the opted out timestamp."
},
"optedOutAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect opted out of emails.",
"format": "date-time"
},
"otherPhones": {
"type": [
"array",
"null"
],
"description": "A list of other phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"personalNote1": {
"type": [
"string",
"null"
],
"description": "A custom note field related to the prospect.",
"maxLength": 65535
},
"personalNote2": {
"type": [
"string",
"null"
],
"description": "A second note field related to the prospect.",
"maxLength": 65535
},
"preferredContact": {
"type": [
"string",
"null"
],
"description": "The preferred contact method for the prospect.",
"maxLength": 255
},
"quoraUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Quora URL.",
"maxLength": 255
},
"region": {
"type": [
"string",
"null"
],
"description": "The primary geographic region of the prospect.",
"maxLength": 255
},
"replyCount": {
"type": [
"integer",
"null"
],
"description": "The number of replies the prospect has made since the last touch point."
},
"school": {
"type": [
"string",
"null"
],
"description": "The school(s) the prospect has attended.",
"maxLength": 255
},
"score": {
"type": [
"number",
"null"
],
"description": "A custom score given to measure the quality of the lead.",
"format": "float"
},
"sharingTeamId": {
"type": [
"string",
"null"
],
"description": "The ID of the sharing team associated with this object. Access is currently in beta.",
"maxLength": 255
},
"source": {
"type": [
"string",
"null"
],
"description": "A custom source representing where the lead was first acquired.",
"maxLength": 255
},
"specialties": {
"type": [
"string",
"null"
],
"description": "A description of the prospect’s specialties.",
"maxLength": 65535
},
"stackOverflowId": {
"type": [
"string",
"null"
],
"description": "The prospect’s StackOverflow ID.",
"maxLength": 255
},
"stackOverflowUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s StackOverflow URL.",
"maxLength": 1000
},
"tags": {
"type": [
"array",
"null"
],
"description": "A list of tag values associated with the account (e.g. [\"Interested\", \"2017 Expo\"]).",
"items": {
"type": "string"
}
},
"timeZone": {
"type": [
"string",
"null"
],
"description": "The prospect’s current timezone, preferably in the IANA format (e.g. \"America/LosAngeles\").",
"maxLength": 255
},
"timeZoneIana": {
"type": [
"string",
"null"
],
"description": "The prospect’s current IANA timezone, if available."
},
"timeZoneInferred": {
"type": [
"string",
"null"
],
"description": "The prospect’s current inferred IANA timezone, if available.",
"maxLength": 255
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the prospect.",
"maxLength": 255
},
"touchedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was last touched.",
"format": "date-time"
},
"trashedAt": {
"type": [
"string",
"null"
],
"description": "The date a prospect was soft deleted.",
"format": "date-time"
},
"twitterUrl": {
"type": [
"string",
"null"
],
"description": "The prospect’s Twitter URL.",
"maxLength": 1000
},
"twitterUsername": {
"type": [
"string",
"null"
],
"description": "The prospect’s Twitter username.",
"maxLength": 255
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the prospect was last updated.",
"format": "date-time"
},
"voipPhones": {
"type": [
"array",
"null"
],
"description": "A list of voip phone numbers associated with the prospect.",
"items": {
"type": "string"
}
},
"websiteUrl1": {
"type": [
"string",
"null"
],
"description": "The URL of the prospect’s website.",
"maxLength": 65535
},
"websiteUrl2": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s second website URL field.",
"maxLength": 65535
},
"websiteUrl3": {
"type": [
"string",
"null"
],
"description": "The value of the prospect’s third website URL field.",
"maxLength": 65535
},
"workPhones": {
"type": [
"array",
"null"
],
"description": "A list of work phone numbers associated with the prospect.",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"account": {
"description": "The prospect's associated account. You can use attributes id, customId, name, named and updatedAt to filter prospects by account (e.g. filter[account][id]=X). You can force a null return on unnamed account by adding in the request actionParams[withUnnamedAccount]=false.",
"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
},
"activeSequenceStates": {
"description": "The non-finished sequence states where this prospect is the primary recipient. This includes states of \"active\", \"paused\", \"failed\", \"bounced\", \"pending\" and \"disabled.\" You can use attributes id and state to filter prospects by activeSequenceStates (e.g. filter[activeSequenceStates][id]=X).",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"sequenceState"
]
}
},
"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
},
"batches": {
"description": "The batches associated with the prospect.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"calls": {
"description": "The calls associated with the prospect. Relationship calls cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creater of the prospect. 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 prospect. If no plugin mapping is enabled, it will return the first plugin mapping associated with the prospect.",
"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
},
"emailAddresses": {
"description": "The prospect's email addresses. Relationship emailAddresses cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"emailAddress"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"favorites": {
"description": "The prospect's favorites. Relationship favorites cannot be used as a filter.",
"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
},
"mailings": {
"description": "The mailings associated with the prospect. Relationship mailings cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunities": {
"description": "The opportunities associated with the prospect. Requires the Opportunities SKU to be enabled in order to have access. Please contact support@outreach.io for more assistance. You can use only the attribute id to filter prospects by opportunities (e.g. filter[opportunities][id]=X).",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunity"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"opportunityProspectRoles": {
"description": "The roles that associate the prospect with opportunities. Relationship opportunityProspectRoles cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"opportunityProspectRole"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"owner": {
"description": "The owner of the prospect. You can use only the attribute id to filter prospects 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
},
"persona": {
"description": "The persona of the prospect, if it has one. You can use only the attribute id to filter prospects by persona (e.g. filter[persona][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"persona"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"phoneNumbers": {
"description": "The prospect's phone numbers Relationship phoneNumbers cannot be used as a filter.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"phoneNumber"
]
}
},
"additionalProperties": false
}
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"sequenceStates": {
"description": "The sequence states where this prospect is the primary recipient. You can use attributes id and state to filter prospects by sequenceStates (e.g. filter[sequenceStates][id]=X).",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"stage": {
"description": "The stage the prospect is in. You can use attributes id and name to filter prospects by stage (e.g. filter[stage][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"stage"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"tasks": {
"description": "The tasks associated with the prospect. Relationship tasks cannot be used as a filter.",
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"trashedByAccount": {
"description": "The account that soft deleted this prospect.",
"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
},
"updater": {
"description": "The most recent updater of the prospect. 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"
}
},
"required": [
"type",
"id"
],
"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_update_prospect --payload '{
"id": "integer",
"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`.