openapi: 3.2.0 info: description: "Outreach Public API is documented here, at the Development Portal, expand the link [Outreach REST API Reference](https://developers.outreach.io/api/reference/overview/) in the left navigation bar to see human-readable description of endpoints and data types.\n\nHowever, if you would like to get machine-readable schema definition there are two other options available:\n\n* [https://api.outreach.io/api/v2/schema.json](https://api.outreach.io/api/v2/schema.json) contains the API definition in the [json-schema format](https://json-schema.org/) and if you provide `Authorization` header with valid token (same as actual API call) all the custom objects defined for the organization will be included as well.\n\n* [https://api.outreach.io/api/v2/schema/openapi.json](https://api.outreach.io/api/v2/schema/openapi.json) contains the API definition in the [OpenAPI / Swagger format](https://swagger.io/specification/). Unfortunately custom objects are not included in this file.\n\nAdditionally to these standard definitions Outreach provides detailed list of validations applied to custom fields. Custom objects will be included later, the work is in progress.\n\n* [https://api.outreach.io/api/v2/types](https://api.outreach.io/api/v2/types) endpoint returns a list of all `customXXX` fields on standard objects with their type, label, options or other constraints defined by the administrator. This endpoint requires valid token in the `Authorization` header. The format of the definitions is described below.\n\n### Custom field types\n\n```json\n{\n \"data\": [\n {\n \"type\": \"\",\n \"meta\": {\n \"validations\": {\n \"\": {\n \"type\": \"\",\n \"required\": true / false,\n \"label\": \"...\",\n \"definition\": null / [\"...\", ...] / \"...\"\n },\n ...\n }\n }\n }\n },\n ...\n ]\n}\n```\n\n#### Objects with custom fields\n\n* Account\n* Opportunity\n* OpportunityLineItem\n* OpportunityProspectRole\n* Product\n* Prospect\n* Purchase\n\n#### Validation types\n\n* `boolean` - true or false\n* `currency` - monetary value, `definition` contains an abbreviation of the currency like `\"USD\"` or `\"EUR\"`\n* `date` - a date stored in ISO8601 format: YYYY-MM-DD.\n* `date_time` a date and time stored as YYYY-MM-DDThh:mm:ss.\n* `inclusion` - a pick list with predefined set of options available in `definition` attribute as a list of strings\n* multi_inclusion - a pick list with several options selectable at once with predefined set of options available in `definition` attribute as a list of strings\n* `numerical`\n* `percentage`\n* `phone_number`\n* `string`\n* `url`\n" title: Outreach REST API Reference Opportunity API version: '' servers: - url: https://api.outreach.io/api/v2 security: - bearerAuth: [] tags: - description: ' ## Opportunity Relationships ## Opportunity Resource Metadata | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** | | --- | --- | --- | | canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta | | canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta | | dataConnections | The set of connections a given Opportunity has to external sources. | provideDataConnections | ## ⌵ Opportunity Actions ' name: Opportunity x-internal: false paths: /opportunities: get: responses: '200': content: application/vnd.api+json: schema: properties: data: items: $ref: '#/components/schemas/opportunityResponse' type: array description: OK '422': content: application/vnd.api+json: schema: properties: errors: items: properties: detail: type: string id: type: string title: type: string type: object type: array description: JSON error message security: - bearerAuth: [] s2sAuthToken: [] summary: Get a Collection of Opportunities tags: - Opportunity x-internal: false post: requestBody: content: application/vnd.api+json: schema: properties: data: properties: attributes: $ref: '#/components/schemas/opportunity' relationships: $ref: '#/components/schemas/opportunityRelationships' type: type: string type: object required: true responses: '201': content: application/vnd.api+json: schema: properties: data: $ref: '#/components/schemas/opportunityResponse' description: Created '422': content: application/vnd.api+json: schema: properties: errors: items: properties: detail: type: string id: type: string title: type: string type: object type: array description: JSON error message security: - bearerAuth: [] s2sAuthToken: [] summary: Create a New Opportunity tags: - Opportunity x-internal: false /opportunities/{id}: delete: parameters: - in: path name: id required: true schema: type: integer responses: '204': content: application/vnd.api+json: {} description: Deleted '422': content: application/vnd.api+json: schema: properties: errors: items: properties: detail: type: string id: type: string title: type: string type: object type: array description: JSON error message security: - bearerAuth: [] s2sAuthToken: [] summary: Delete an Existing Opportunity by ID tags: - Opportunity x-internal: false get: parameters: - in: path name: id required: true schema: type: integer responses: '200': content: application/vnd.api+json: schema: properties: data: $ref: '#/components/schemas/opportunityResponse' description: OK '404': content: application/vnd.api+json: schema: properties: errors: items: properties: detail: type: string id: type: string title: type: string type: object type: array description: Not Found security: - bearerAuth: [] s2sAuthToken: [] summary: Get an Opportunity by ID tags: - Opportunity x-internal: false patch: parameters: - in: path name: id required: true schema: type: integer requestBody: content: application/vnd.api+json: schema: properties: data: properties: attributes: $ref: '#/components/schemas/opportunity' id: type: integer relationships: $ref: '#/components/schemas/opportunityRelationships' type: type: string required: - type - id type: object required: true responses: '200': content: application/vnd.api+json: schema: properties: data: properties: attributes: $ref: '#/components/schemas/opportunity' id: type: integer relationships: $ref: '#/components/schemas/opportunityRelationships' type: type: string required: - type - id type: object description: OK '422': content: application/vnd.api+json: schema: properties: errors: items: properties: detail: type: string id: type: string title: type: string type: object type: array description: JSON error message security: - bearerAuth: [] s2sAuthToken: [] summary: Update an Opportunity tags: - Opportunity x-internal: false components: schemas: opportunityRelationships: 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: properties: id: type: integer type: enum: - account type: string type: - object - 'null' links: properties: related: format: uri type: string type: object assignedTeams: description: '' properties: data: items: properties: id: type: integer type: enum: - team type: string type: object type: array links: properties: related: format: uri type: string type: object assignedUsers: description: '' properties: data: items: properties: id: type: integer type: enum: - user type: string type: object type: array links: properties: related: format: uri type: string type: object creator: description: ' The creator of the opportunity. Relationship creator cannot be used as a filter.' properties: data: properties: id: type: integer type: enum: - user type: string type: - object - 'null' links: properties: related: format: uri type: string type: object 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: properties: id: type: integer type: enum: - pluginMapping type: string type: - object - 'null' links: properties: related: format: uri type: string type: object externalCreator: description: '' properties: data: properties: id: type: integer type: enum: - user type: string type: - object - 'null' links: properties: related: format: uri type: string type: object favorites: description: The opportunity favorited by the user. properties: data: items: properties: id: type: integer type: enum: - favorite type: string type: object type: array links: properties: related: format: uri type: string type: object opportunityHealthFactors: description: The factors related to the opportunities health. properties: data: items: properties: id: type: integer type: enum: - opportunityHealthFactor type: string type: object type: array links: properties: related: format: uri type: string type: object opportunityLineItems: description: The products associated with opportunity. properties: data: items: properties: id: type: integer type: enum: - opportunityLineItem type: string type: object type: array links: properties: related: format: uri type: string type: object 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: properties: id: type: integer type: enum: - opportunityStage type: string type: - object - 'null' links: properties: related: format: uri type: string type: object 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: properties: id: type: integer type: enum: - user type: string type: - object - 'null' links: properties: related: format: uri type: string type: object primaryProspect: description: '' properties: data: properties: id: type: integer type: enum: - prospect type: string type: - object - 'null' links: properties: related: format: uri type: string type: object 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: properties: related: format: uri type: string type: object 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: properties: id: type: integer type: enum: - opportunityStage type: string type: - object - 'null' links: properties: related: format: uri type: string type: object 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: properties: id: type: integer type: enum: - territory type: string type: - object - 'null' links: properties: related: format: uri type: string type: object updater: description: ' The updater of the opportunity. Relationship updater cannot be used as a filter.' properties: data: properties: id: type: integer type: enum: - user type: string type: - object - 'null' links: properties: related: format: uri type: string type: object type: object opportunityResponse: properties: attributes: $ref: '#/components/schemas/opportunity' id: type: integer relationships: $ref: '#/components/schemas/opportunityRelationships' type: type: string type: object x-internal: false opportunity: 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: description: ' The amount the opportunity is worth.' type: - integer - 'null' x-internal: false amountPrecise: description: ' The precise amount that the opportunity is worth.' maxLength: 15 type: - string - 'null' x-internal: false closeDate: description: ' The date the opportunity is expected to close.' format: date-time type: - string - 'null' x-internal: false createdAt: description: ' The date the opportunity was created.' format: date-time type: - string - 'null' x-internal: false currencyType: description: ' The ISO code of the currency this opportunity is in.' maxLength: 255 type: - string - 'null' x-internal: false custom1: description: ' The value of the opportunity''s first custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom2: description: ' The value of the opportunity''s second custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom3: description: ' The value of the opportunity''s third custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom4: description: ' The value of the opportunity''s fourth custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom5: description: ' The value of the opportunity''s fifth custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom6: description: ' The value of the opportunity''s sixth custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom7: description: ' The value of the opportunity''s seventh custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom8: description: ' The value of the opportunity''s eighth custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom9: description: ' The value of the opportunity''s ninth custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom10: description: ' The value of the opportunity''s 10th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom11: description: ' The value of the opportunity''s 11th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom12: description: ' The value of the opportunity''s 12th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom13: description: ' The value of the opportunity''s 13th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom14: description: ' The value of the opportunity''s 14th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom15: description: ' The value of the opportunity''s 15th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom16: description: ' The value of the opportunity''s 16th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom17: description: ' The value of the opportunity''s 17th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom18: description: ' The value of the opportunity''s 18th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom19: description: ' The value of the opportunity''s 19th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom20: description: ' The value of the opportunity''s 20th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom21: description: ' The value of the opportunity''s 21st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom22: description: ' The value of the opportunity''s 22nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom23: description: ' The value of the opportunity''s 23rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom24: description: ' The value of the opportunity''s 24th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom25: description: ' The value of the opportunity''s 25th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom26: description: ' The value of the opportunity''s 26th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom27: description: ' The value of the opportunity''s 27th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom28: description: ' The value of the opportunity''s 28th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom29: description: ' The value of the opportunity''s 29th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom30: description: ' The value of the opportunity''s 30th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom31: description: ' The value of the opportunity''s 31st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom32: description: ' The value of the opportunity''s 32nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom33: description: ' The value of the opportunity''s 33rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom34: description: ' The value of the opportunity''s 34th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom35: description: ' The value of the opportunity''s 35th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom36: description: ' The value of the opportunity''s 36th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom37: description: ' The value of the opportunity''s 37th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom38: description: ' The value of the opportunity''s 38th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom39: description: ' The value of the opportunity''s 39th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom40: description: ' The value of the opportunity''s 40th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom41: description: ' The value of the opportunity''s 41st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom42: description: ' The value of the opportunity''s 42nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom43: description: ' The value of the opportunity''s 43rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom44: description: ' The value of the opportunity''s 44th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom45: description: ' The value of the opportunity''s 45th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom46: description: ' The value of the opportunity''s 46th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom47: description: ' The value of the opportunity''s 47th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom48: description: ' The value of the opportunity''s 48th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom49: description: ' The value of the opportunity''s 49th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom50: description: ' The value of the opportunity''s 50th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom51: description: ' The value of the opportunity''s 51st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom52: description: ' The value of the opportunity''s 52nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom53: description: ' The value of the opportunity''s 53rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom54: description: ' The value of the opportunity''s 54th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom55: description: ' The value of the opportunity''s 55th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom56: description: ' The value of the opportunity''s 56th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom57: description: ' The value of the opportunity''s 57th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom58: description: ' The value of the opportunity''s 58th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom59: description: ' The value of the opportunity''s 59th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom60: description: ' The value of the opportunity''s 60th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom61: description: ' The value of the opportunity''s 61st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom62: description: ' The value of the opportunity''s 62nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom63: description: ' The value of the opportunity''s 63rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom64: description: ' The value of the opportunity''s 64th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom65: description: ' The value of the opportunity''s 65th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom66: description: ' The value of the opportunity''s 66th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom67: description: ' The value of the opportunity''s 67th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom68: description: ' The value of the opportunity''s 68th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom69: description: ' The value of the opportunity''s 69th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom70: description: ' The value of the opportunity''s 70th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom71: description: ' The value of the opportunity''s 71st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom72: description: ' The value of the opportunity''s 72nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom73: description: ' The value of the opportunity''s 73rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom74: description: ' The value of the opportunity''s 74th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom75: description: ' The value of the opportunity''s 75th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom76: description: ' The value of the opportunity''s 76th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom77: description: ' The value of the opportunity''s 77th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom78: description: ' The value of the opportunity''s 78th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom79: description: ' The value of the opportunity''s 79th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom80: description: ' The value of the opportunity''s 80th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom81: description: ' The value of the opportunity''s 81st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom82: description: ' The value of the opportunity''s 82nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom83: description: ' The value of the opportunity''s 83rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom84: description: ' The value of the opportunity''s 84th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom85: description: ' The value of the opportunity''s 85th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom86: description: ' The value of the opportunity''s 86th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom87: description: ' The value of the opportunity''s 87th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom88: description: ' The value of the opportunity''s 88th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom89: description: ' The value of the opportunity''s 89th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom90: description: ' The value of the opportunity''s 90th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom91: description: ' The value of the opportunity''s 91st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom92: description: ' The value of the opportunity''s 92nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom93: description: ' The value of the opportunity''s 93rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom94: description: ' The value of the opportunity''s 94th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom95: description: ' The value of the opportunity''s 95th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom96: description: ' The value of the opportunity''s 96th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom97: description: ' The value of the opportunity''s 97th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom98: description: ' The value of the opportunity''s 98th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom99: description: ' The value of the opportunity''s 99th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom100: description: ' The value of the opportunity''s 100th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom101: description: ' The value of the opportunity’s 101st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom102: description: ' The value of the opportunity’s 102nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom103: description: ' The value of the opportunity’s 103rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom104: description: ' The value of the opportunity’s 104th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom105: description: ' The value of the opportunity’s 105th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom106: description: ' The value of the opportunity’s 106th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom107: description: ' The value of the opportunity’s 107th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom108: description: ' The value of the opportunity’s 108th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom109: description: ' The value of the opportunity’s 109th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom110: description: ' The value of the opportunity’s 110th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom111: description: ' The value of the opportunity’s 111th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom112: description: ' The value of the opportunity’s 112th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom113: description: ' The value of the opportunity’s 113th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom114: description: ' The value of the opportunity’s 114th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom115: description: ' The value of the opportunity’s 115th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom116: description: ' The value of the opportunity’s 116th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom117: description: ' The value of the opportunity’s 117th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom118: description: ' The value of the opportunity’s 118th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom119: description: ' The value of the opportunity’s 119th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom120: description: ' The value of the opportunity’s 120th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom121: description: ' The value of the opportunity’s 121st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom122: description: ' The value of the opportunity’s 122nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom123: description: ' The value of the opportunity’s 123rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom124: description: ' The value of the opportunity’s 124th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom125: description: ' The value of the opportunity’s 125th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom126: description: ' The value of the opportunity’s 126th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom127: description: ' The value of the opportunity’s 127th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom128: description: ' The value of the opportunity’s 128th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom129: description: ' The value of the opportunity’s 129th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom130: description: ' The value of the opportunity’s 130th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom131: description: ' The value of the opportunity’s 131st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom132: description: ' The value of the opportunity’s 132nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom133: description: ' The value of the opportunity’s 133rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom134: description: ' The value of the opportunity’s 134th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom135: description: ' The value of the opportunity’s 135th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom136: description: ' The value of the opportunity’s 136th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom137: description: ' The value of the opportunity’s 137th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom138: description: ' The value of the opportunity’s 138th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom139: description: ' The value of the opportunity’s 139th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom140: description: ' The value of the opportunity’s 140th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom141: description: ' The value of the opportunity’s 141st custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom142: description: ' The value of the opportunity’s 142nd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom143: description: ' The value of the opportunity’s 143rd custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom144: description: ' The value of the opportunity’s 144th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom145: description: ' The value of the opportunity’s 145th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom146: description: ' The value of the opportunity’s 146th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom147: description: ' The value of the opportunity’s 147th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom148: description: ' The value of the opportunity’s 148th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom149: description: ' The value of the opportunity’s 149th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false custom150: description: ' The value of the opportunity’s 150th custom field.' maxLength: 32000 type: - string - 'null' x-internal: false customId: description: ' A custom ID for the opportunity, often referencing an ID in an external system.' maxLength: 255 type: - string - 'null' x-internal: false description: description: ' A description of the opportunity.' maxLength: 65535 type: - string - 'null' x-internal: false externalCreatedAt: description: ' The date the opportunity was created in the external system.' format: date-time type: - string - 'null' x-internal: false externalUpdatedAt: description: ' The date the opportunity was last updated in the external system.' format: date-time type: - string - 'null' x-internal: false forecastCategory: description: ' The category or classification used to predict the likelihood of closing an opportunity.' maxLength: 32000 type: - string - 'null' x-internal: false leadSource: description: ' Source of this opportunity, such as Advertisement or Trade Show' maxLength: 32000 type: - string - 'null' x-internal: false lostReason: description: ' The reason why an opportunity or deal was lost.' maxLength: 32000 type: - string - 'null' x-internal: false mapLink: description: ' A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.' maxLength: 255 type: - string - 'null' x-internal: false mapNextSteps: description: ' The next event in the timeline that has yet to be completed for the SamePlan MAP (Mutual Action Plan).' maxLength: 255 type: - string - 'null' x-internal: false mapStatus: description: ' The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.' maxLength: 255 type: - string - 'null' x-internal: false name: description: ' The name of the opportunity.' maxLength: 255 type: - string - 'null' x-internal: false nextStep: description: ' The next step to take for the opportunity.' maxLength: 65535 type: - string - 'null' x-internal: false opportunityType: description: ' The type of opportunity.' maxLength: 255 type: - string - 'null' x-internal: false probability: description: ' The chances of the opportunity succeeding, represented as a percentage.' type: - integer - 'null' x-internal: false prospectingRepId: description: ' The ID of the sales rep that prospects the opportunity.' maxLength: 255 type: - string - 'null' x-internal: false recordType: 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 type: - string - 'null' x-internal: false sharingTeamId: description: ' The ID of the sharing team associated with this object. Access is currently in beta.' maxLength: 255 type: - string - 'null' x-internal: false tags: description: ' Tags associated with the opportunity.' items: type: string type: - array - 'null' x-internal: false touchedAt: description: ' The last time an event happened for an opportunity.' format: date-time type: - string - 'null' x-internal: false trashedAt: description: ' The date a prospect was soft deleted.' format: date-time type: - string - 'null' x-internal: false updatedAt: description: ' The date the opportunity was last updated.' format: date-time type: - string - 'null' x-internal: false type: object x-internal: false securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http s2sAuthToken: bearerFormat: JWT scheme: bearer type: http