Skip to main content
POST
/
v1
/
preview
/
opportunities
Create Opportunity
curl --request POST \
  --url https://api.example.com/v1/preview/opportunities/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stage": "negotiation",
  "estimated_value": {
    "currency_code": "USD",
    "amount": 5000000
  },
  "estimated_close_date": "2025-09-30",
  "notes": "Follow up after Q3 board meeting",
  "tags": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "data": {
    "id": "<string>",
    "account_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "Acme Corp - Enterprise License",
    "owner": {
      "id": "<string>",
      "first_name": "Jane",
      "last_name": "Smith"
    },
    "stage": "negotiation",
    "estimated_value": {
      "currency_code": "USD",
      "amount": 5000000
    },
    "estimated_close_date": "2025-09-30",
    "actual_close_date": "2025-10-15",
    "summary": "Enterprise deal with strong champion. Procurement review in progress.",
    "risks": [
      "<string>"
    ],
    "notes": "Follow up after Q3 board meeting",
    "tags": [
      "<string>"
    ],
    "last_activity_at": "2025-08-20T14:30:00Z",
    "updated_at": "2025-08-21T14:30:00Z"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.monaco.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Request body for creating an opportunity via POST.

​
name
string
required

Name of the opportunity

Example:

"Acme Corp - Enterprise License"

​
account_id
string<uuid>
required

ID of the account to associate the opportunity with

​
owner_user_id
string<uuid> | null

User ID to assign as opportunity owner

​
stage
string | null

Pipeline stage key for the opportunity

Example:

"negotiation"

​
estimated_value
EstimatedValue · object

Estimated monetary value of the opportunity

​
estimated_close_date
string | null

Expected close date (YYYY-MM-DD)

Example:

"2025-09-30"

​
notes
string | null

Notes about the opportunity

Example:

"Follow up after Q3 board meeting"

​
tags
string<uuid>[] | null

List of tag IDs to associate with the opportunity

​
idempotency_key
string<uuid> | null

Client-provided idempotency key to prevent duplicate creation

Response

Successful Response

​
data
OpportunityResponse · object
required

Opportunity resource.

Custom fields appear as additional keys prefixed with custom_field_.

​
meta
ResponseMeta · object