Create an opportunity

post https://www.ruddr.io/api/workspace/opportunities

Body Params

name

string

required

The name of the opportunity (max 255 chars).

companyId

string

required

The company ID (uuid) of the company associated with this opportunity.

opportunityStageId

string

The opportunity stage ID (uuid) of the opportunity stage associated with this opportunity. Will default to the opportunity stage with the lowest probability if not supplied.

description

boolean

The opportunity description (max 5000 chars).

nextSteps

string

The next steps of the opportunity (max 255 chars).

amount

float

The amount of the opportunity.

isActive

boolean

A flag to indicate if the opportunity is active in the system. Defaults true if not provided.

probability

float

Percentage chance of the opportunity progressing to a successful conclusion. Accepts a value of 0 to 1 using a maximum of four decimals.

closeDate

date

The close date (YYYY-MM-DD) of the opportunity.

priorityId

string

The priority of the opportunity. Possible values are: "high" (High), "medium" (Medium) or "low" (Low).

currency

string

The 3-letter currency code associated with the opportunity. Will default to the workspace setting if not supplied.

ownerId

string

The member ID (uuid) of the owner of this opportunity.

opportunityLeadSourceId

string

The opportunity lead source ID (uuid) of the opportunity lead source associated with this opportunity.

opportunityTypeId

string

The opportunity type ID (uuid) of the opportunity type associated with this opportunity.

tagIds

array of strings

A list of opportunity tag IDs (uuid) associated with this opportunity.

tagIds

practiceId

string

The practice ID (uuid) of the practice associated with this opportunity.

projectId

string

The project ID (uuid) of the project associated with this opportunity.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://www.ruddr.io/api/workspace/opportunities \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400