API Reference

Create a new opportunity

post
https://api.maximizer.com/ferret/v1/opportunities
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Notice to Ferret API (v1) users

We’re excited to announce the beta release of Ferret API v2, offering a more consistent and expanded approach, with access to a wider range of objects.

New clients are encouraged to start with Ferret API v2 and/or Octopus API to take advantage of the latest updates. Existing clients are also encouraged to transition to v2, although Ferret API v1 will remain stable and fully operational. For those looking to migrate to the Octopus API, we’ve prepared a detailed migration guide.

Body Params

Command to create an opportunity

string | null

Opportunity's legacy contact key


*Required when LegacyCompanyKey is empty
Contact type must not be Lead

string | null

Opportunity's legacy company key


*Required when LegacyContactKey is empty

double | null

Opportunity's Current Revenue

double | null

Opportunity's Forecast Revenue

double | null

Opportunity's Cost

string
required
length ≥ 1

Opportunity's name

date-time | null

Opportunity's Start Date

date-time | null

Opportunity's Close Date

string | null

Opportunity's Comment

string | null

Opportunity's Confidence

string | null

Opportunity's Description

int32
enum

1 = GreatPrice, 2 = ExcellentPresentation, 3 = LikedSelection, 4 = LostToCompetitor, 5 = PoorPresentation, 6 = TooExpensive, 7 = NotEnoughProfit, 8 = NewManagement, 9 = Delayed

int32
enum
required

0 = New, 2 = InProgress, 3 = Won, 4 = Lost, 5 = Abandoned, 6 = Suspended

Allowed:
string | null

Opportunity's next step

string | null

Key of the sales process to which the opportunity should belong to

string | null

Key of the sales stage to which the opportunity should belong to

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Updated 11 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 11 months ago

Did this page help you?