Opportunity

An object representing an opportunity.

Supported API Calls: Get | Add | Update | Delete

Object Properties

Property

Type

Description

Id

integer

A unique ID for the Opportunity object. When adding a new Opportunity the value must be 0.

Name

string (100)

Name of the opportunity.

Description

string (100)

Text for the Opportunity's description field.

Amount

double

Text for the Opportunity's Valued At field. This value is optional.

ParentId

integer

The ID of the parent organization.

ParentObject

string (100)

ParentObject identifies what kind of object the Opportunity object is a child of. Value is Account (if it's an organization) or Lead.

CloseDate

DateTime

Value for the Opportunity's Estimated Closing Date. This value is optional.

CurrencyIsoCode

string (100)

Currency symbol used for the value on display.

IsClosed

boolean

Flag to indicate the opportunity is closed and can't be edited.

IsWon

boolean

Flag to indicate the opportunity was won and converted to a project.

OwnerId

integer

The ID of the user who owns this object.

IsLocked

boolean

Flag to indicate this orbject is available in BlueCamroo but cannot be edited. This property is read only

StageName

integer

ID to set the opportunity's Phase-down box. Value should be equal to the OpportunityPhase object's ID field.

Probability

float

A percentage amount for the Opportunity's Probability field. This value is optional.

PriceBookId

integer

ID of a pricebook object. This value is optional.

CreatedBy

integer

ID of the user who created this opportunity. Read only.

CreationDate

DateTime

Indicates when this object was created. Read only.

LastModifiedBy

integer

ID of the user who last modified this opportunity. Read only.

LastModifiedDate

DateTime

Date the object was last modified. This value is optional. Read only.

IsWatched

boolean

Flag to indicate this record's update stream is watched.

ReviewDate

DateTime

Date and time this record needs to be reviewed.

RelatedParentId

integer

ID of the object this opportunity is related to (a person or organization).

RelatedParentObject

string (100)

Indicate if the parent is an account (if it's an organization) or person object.

Get

Description

Returns the details of a specified opportunity.

URL

https://{company}.bluecamroo.com/api/opportunity/{id}

HTTP Method

GET

Parameters

None

Data Return

Returns an opportunity object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Add

Description

Adds an opportunity object.

URL

https://{company}.bluecamroo.com/api/opportunity/add

HTTP Method

POST

Parameters

An opportunity object

Data Return

Returns the opportunity object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

201: Created

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Update

Description

Updates the specified opportunity.

URL

https://{company}.bluecamroo.com/api/opportunity/update

HTTP Method

PUT

Parameters

An opportunity object

Data Return

Returns the opportunity object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Delete

Description

Deletes the specified opportunity.

URL

https://{company}.bluecamroo.com/api/opportunity/delete/{id}

HTTP Method

DELETE

Parameters

None

Data Return

None

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)