v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Deals

Create Deal

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

<a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities. Use the Create Deal endpoint to create new deals for an Apollo account. To update existing deals in your Apollo account, use the <a href="https://docs.apollo.io/reference/update-deal">Update Deal endpoint</a> instead. This endpoint requires a master API key. If you call the endpoint without a master key, you receive a 403 response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.

post/opportunities

Request body

namestring required

Name the deal you are creating. This should be a human-readable name. Example: Massive Q3 Deal

owner_idstring

The ID for the deal owner within your team's Apollo account. Use the <a href="https://docs.apollo.io/reference/get-a-list-of-users" target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all of the users within your Apollo account. Example: 66302798d03b9601c7934ebf

account_idstring

The ID for the account within your Apollo instance. This is the company that you are targeting as part of the deal being created. Each company in the Apollo database is assigned a unique ID. To find IDs, call the <a href="https://docs.apollo.io/reference/organization-search" target="_blank">Organization Search endpoint</a> and identify the values for organization_id. Example: 5e66b6381e05b4008c8331b8

amountstring

The monetary value of the deal being created. Do not enter commas or currency symbols for the value. The currency is automatically populated by the settings within your Apollo account. Commas are not accepted and result in the deal amount being left blank. Example: 55123478 (results in a deal value of $55,123,478 if the default currency is USD)

opportunity_stage_idstring

The ID for the deal stage within your team's Apollo account. Each deal stage is assigned a unique ID. To find deal stage IDs, call the <a href="https://docs.apollo.io/reference/list-deal-stages" target="_blank">List Deal Stages endpoint</a> and identify the value for id for each stage. Example: 6095a710bd01d100a506d4bd

closed_datestring date

The estimated close date for the deal. This can be a future or past date. The date should be formatted as YYYY-MM-DD. Example: 2025-10-30

typed_custom_fieldsobject

Add information to <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062486669-Create-a-Deal" target="_blank">custom fields</a> in Apollo. Your custom fields are unique to your team's Apollo account. This means that the examples in this documentation may not work for your testing purposes. To utilize this parameter successfully, call the <a href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Get a List of All Custom Fields</a> endpoint and identify the id value for the custom field, as well as the appropriate data type. For example, if a custom field accepts picklist entries, you need to pass the accompanying id value for the picklist entry that you want to use as the input value. Example: When the <a href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Get a List of All Custom Fields</a> endpoint returns an id of field:

"60c39ed82bd02f01154c470a" (datetime)

then the value passed should be:

{"60c39ed82bd02f01154c470a": "2025-08-07"}

Example request

{
  "typed_custom_fields": {
    "60c39ed82bd02f01154c470a": "2025-08-07"
  }
}

Response

200

Example response

{
  "opportunity": {
    "id": "66e09ea8e3cfcf01b2208ec7",
    "team_id": "6095a710bd01d100a506d4ac",
    "owner_id": "66302798d03b9601c7934ebf",
    "amount": 99999999,
    "account_id": "55e16cfbf3e5bb66cf0026f3",
    "name": "Massive Space Deal",
    "opportunity_stage_id": "6095a710bd01d100a506d4bd",
    "source": "api",
    "created_at": "2024-09-10T19:31:52.436Z",
    "forecast_category": "pipeline",
    "deal_probability": 10,
    "created_by_id": "60affe7d6e270a00f5db6fe4",
    "opportunity_pipeline_id": "654b989fcb2a5200010a90db",
    "stage_updated_at": "2024-09-10T19:31:52.436+00:00",
    "exchange_rate_code": "USD",
    "exchange_rate_value": 1,
    "amount_in_team_currency": 99999999,
    "forecasted_revenue": 9999999.9,
    "last_activity_date": "2024-09-10T19:31:52.436Z",
    "existence_level": "none",
    "currency": {
      "name": "US Dollar",
      "iso_code": "USD",
      "symbol": "$"
    }
  }
}