Skip to main content
POST
Create an Opportunity

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 | null

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