Skip to main content
POST
/
v1
/
opportunities
Create opportunity
curl --request POST \
  --url https://api.octolane.com/v1/opportunities \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "pipeline_id": "018f13b3-8239-7ef8-a8f1-93ad10b76110",
  "opportunity": {
    "name": "<string>",
    "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stage_name": "<string>",
    "deal_size": 123,
    "close_date": 123,
    "next_action_date": 123,
    "next_steps": "<string>",
    "custom_attributes": {}
  },
  "related_objects": {
    "account_domain": "acme.com",
    "primary_contact_email": "jsmith@example.com",
    "additional_contact_emails": [
      "jsmith@example.com"
    ],
    "owner_email": "jsmith@example.com",
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": "<unknown>"
}

Authorizations

x-api-key
string
header
required

Public API key for the Octolane organization.

Body

application/json

Opportunity payload.

pipeline_id
string<uuid>
required

Target pipeline ID.

Example:

"018f13b3-8239-7ef8-a8f1-93ad10b76110"

opportunity
object
required

Response

Opportunity was created.

success
boolean
Example:

true

message
string
data
any

Endpoint-specific response payload.