v2

latestSwagger 2.02026-08-01720512.4 KB

Opportunities

Create an opportunity

post/opportunities

Request body

ownernumber

The ID of the user who owns the opportunity.

accountnumber required

stagenumber

The Salesflare ID of the stage.

lost_reasonnumber

The reason the opportunity was lost.

filesobject[]

List of files associated with the opportunity.

lead_sourcenumber

The source of the opportunity.

start_datestring date-time

The start date of the opportunity (ISO 8601 date-time).

probabilitynumber

The probability that the opportunity will be won.

assigneenumber

The ID of the user assigned to the opportunity.

creatornumber

The ID of the user who created the opportunity.

statusstring

Deprecated. Do not use this field.

namestring

The opportunity name.

valuenumber

The monetary value of the opportunity.

currencynumber

The currency ID of the opportunity.

status_datestring

Deprecated. Do not use this field.

close_datestring date-time

The date the opportunity was closed (ISO 8601 date-time).

closedboolean

Whether the opportunity is closed.

tagsstring[]

List of tags associated with the opportunity.

recurring_price_per_unitnumber

The recurring price per unit of the opportunity.

frequency'annually' | 'weekly' | 'monthly' | 'daily'

The recurrence frequency of the opportunity. Allowed values: annually, weekly, monthly, daily.

unitsnumber

The number of units for the opportunity.

contract_start_datestring date-time

The contract start date (ISO 8601 date-time).

contract_end_datestring date-time

The contract end date (ISO 8601 date-time).

main_contactnumber

customobject

Custom field values associated with the opportunity.

Response

Successful