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

# Apollo: Create Deal

> ## Endpoint essentials **API key access:** `deals/api/v1/opportunities/create` or `Master API key` **OAuth scopes:** `opportunity_write` **Credit usage:** `0.

## Endpoint essentials **API key access:** `deals/api/v1/opportunities/create` or `Master API key` **OAuth scopes:** `opportunity_write` **Credit usage:** \`0.

<Info>
  Tool ID: `apollo_create_deal`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apollo_create_deal',
  {
    "name": "Example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute apollo_create_deal --input '{
  "name": "Example"
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get apollo_create_deal --json` for the complete live contract.

## Input reference

Create a new deal (opportunity) in Apollo CRM. Requires master API key.

| Name                           | Type     | Required | Default | Details                                                                   |
| ------------------------------ | -------- | -------- | ------- | ------------------------------------------------------------------------- |
| `payload.name`                 | `string` | Yes      | —       | Name of the deal.                                                         |
| `payload.amount`               | `number` | No       | —       | Monetary value of the deal.                                               |
| `payload.opportunity_stage_id` | `string` | No       | —       | ID of the deal stage. Retrieve stage IDs with apollo\_list\_deal\_stages. |
| `payload.account_id`           | `string` | No       | —       | Apollo account (company) ID associated with this deal.                    |
| `payload.owner_id`             | `string` | No       | —       | Apollo user ID who owns this deal.                                        |
| `payload.close_date`           | `string` | No       | —       | Expected close date (ISO 8601 date string, e.g. "2026-06-30").            |
| `payload.source`               | `string` | No       | —       | Source or origin of the deal (e.g. "Inbound", "Outbound").                |
| `payload.status`               | `string` | No       | —       | Current status of the deal (e.g. "Open", "Won", "Lost").                  |
| `payload.priority`             | `string` | No       | —       | Priority level of the deal (e.g. "High", "Medium", "Low").                |
| `payload.notes`                | `string` | No       | —       | Free-text notes about the deal.                                           |
| `payload.custom_fields`        | `record` | No       | —       | Custom field key-value pairs for the deal.                                |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Create a new deal (opportunity) in Apollo CRM. Requires master API key.",
    "properties": {
      "name": {
        "type": "string",
        "description": "Name of the deal."
      },
      "amount": {
        "type": "number",
        "description": "Monetary value of the deal."
      },
      "opportunity_stage_id": {
        "type": "string",
        "description": "ID of the deal stage. Retrieve stage IDs with apollo_list_deal_stages."
      },
      "account_id": {
        "type": "string",
        "description": "Apollo account (company) ID associated with this deal."
      },
      "owner_id": {
        "type": "string",
        "description": "Apollo user ID who owns this deal."
      },
      "close_date": {
        "type": "string",
        "description": "Expected close date (ISO 8601 date string, e.g. \"2026-06-30\")."
      },
      "source": {
        "type": "string",
        "description": "Source or origin of the deal (e.g. \"Inbound\", \"Outbound\")."
      },
      "status": {
        "type": "string",
        "description": "Current status of the deal (e.g. \"Open\", \"Won\", \"Lost\")."
      },
      "priority": {
        "type": "string",
        "description": "Priority level of the deal (e.g. \"High\", \"Medium\", \"Low\")."
      },
      "notes": {
        "type": "string",
        "description": "Free-text notes about the deal."
      },
      "custom_fields": {
        "type": "object",
        "description": "Custom field key-value pairs for the deal.",
        "additionalProperties": {}
      }
    },
    "required": [
      "name"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo create deal result.

| Name          | Type     | Required | Default | Details                                        |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `record` | Yes      | —       | Payload with the created `opportunity` object. |
| `result.meta` | `record` | No       | —       | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Apollo create deal result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Payload with the created `opportunity` object.",
        "additionalProperties": {}
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Apollo provider guide](/docs/providers/apollo/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)