Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Body

application/json
name
string
required
Maximum string length: 255
pipelineId
string<uuid>
required
stageId
string<uuid>
required
value
number
currency
string
Maximum string length: 10
expectedCloseDate
string
notes
string
Maximum string length: 10000
crmCompanyId
string<uuid>
contactId
string<uuid>
ownerId
string
contacts
object[]
customFields
object

Response

201 - application/json
id
string
required
name
string
required
pipelineId
string
required
stageId
string
required
ownerId
string
required
companyId
string
required
enteredStageAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
value
number
currency
string
expectedCloseDate
string<date-time>
notes
string
crmCompanyId
string
contactId
string
lostReason
enum<string>
Available options:
price,
competition,
timing,
no_budget,
no_response,
feature_missing,
other
lostReasonNote
string
wonAt
string<date-time>
lostAt
string<date-time>
customFields
object
crmCompany
object
contact
object
stage
object
contacts
object[]
owner
object
isRotting
boolean