Skip to main content
POST
Create an opportunity

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Body

application/json
companyId
string
required

The ID of the company this opportunity belongs to

Minimum string length: 1
name
string
required

The name of the opportunity

Minimum string length: 1
description
string | null
required

Detailed description of the opportunity

stageId
string
required

The pipeline stage ID to assign to this opportunity

Minimum string length: 1
closeDate
object
required

The target closing date for this opportunity

ownerId
string

The user ID of the opportunity owner

Minimum string length: 1
clientTeam
object[]

Client contacts to associate with this opportunity

locations
object[]

Physical locations for the opportunity (0 to 15).

Maximum array length: 15

Response

Opportunity created successfully. Returns the opportunity ID.

id
string
required
Minimum string length: 1