Sign in

v1

latestOpenAPI 3.1.02026-07-263788129.7 KB
Opportunities

Create an Opportunity

Creates a new opportunity associated with an existing account. Pass an idempotency_key to safely retry creation.

post/v1/opportunities/

Request body

namestring required

Name of the opportunity

account_idstring uuid required

ID of the account to associate the opportunity with

owner_user_idstring uuid nullable

User ID to assign as opportunity owner

stagestring nullable

Pipeline stage key for the opportunity

estimated_close_datestring nullable

Expected close date (YYYY-MM-DD)

notesstring nullable

Notes about the opportunity

tagsstring[] nullable

List of tag IDs to associate with the opportunity

idempotency_keystring uuid nullable

Client-provided idempotency key to prevent duplicate creation

Example request

{
  "name": "Acme Corp - Enterprise License",
  "stage": "negotiation",
  "estimated_value": {
    "currency_code": "USD",
    "amount": 5000000
  },
  "estimated_close_date": "2025-09-30",
  "notes": "Follow up after Q3 board meeting"
}

Response

Successful Response

Example response

{
  "data": {
    "id": "opp_abc123",
    "account_id": "acc_def456",
    "name": "Acme Corp - Enterprise License",
    "owner": {
      "id": "usr_abc123",
      "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": [
      "Budget constraints",
      "Competing vendor evaluation"
    ],
    "notes": "Follow up after Q3 board meeting",
    "tags": [
      "High Priority"
    ],
    "last_activity_at": "2025-08-20T14:30:00Z",
    "updated_at": "2025-08-21T14:30:00Z",
    "created_at": "2025-06-01T09:00:00Z"
  }
}