/
Opportunity Object v2

Opportunity Object v2

Owned by Matt Sullivan (Unlicensed)
Last updated: Aug 24, 2022
2 min read

Path Parameters

HTTP Header

api-key status:REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

relationship ID status:REQUIRED
integer - ID of your chosen relationship

opportunity ID status:OPtional
integer - ID of your chosen opportunity

Opportunity Requests status:GEt status:Post status:put

status:Get status:Post - Retrieve opportunities from a relationship or add a new opportunity into a relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/opportunities/

Example Payload status:POSt

{ "opportunity_type": "Single Car", "opportunity_status": "New Opportunity", "opportunity_source": "Email", "quality": "High" }

Response

status:200
Returned if the request is successful.

{ "items": [ { "opportunity_id": 542425, "opportunity_type": "Single Car", "opportunity_status": "New Opportunity", "opportunity_source": "Email", "opportunity_sub_source": null, "description": null, "quality": "Medium", "units_car": null, "units_lcv": null, "value": null, "target_close_date": null, "close_date": null, "brand": "Examples's Dev", "account_manager": "example@example.com", "tracking_field_1": null, "tracking_field_2": null, "tracking_field_3": null, "tracking_field_4": null, "tracking_field_5": null, "creation_date": "2022-08-02T09:03:10.921Z", "loss_reason": null, "loss_details": null } ], "first": { "$ref": "https://example.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/opportunities/" } }

status:400
Returned if the request sent is invalid.

status:404
Returned if the request is not found or the user does not have permission to view it.

status:Put - Update an existing opportunity within a relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/opportunities/{id}/

Example Payload status:PUT

{ "opportunity_type": "Single Car", "opportunity_status": "New Opportunity", "opportunity_source": "Email", "description": "Customer is interested in leasing one vehicle.", "quality": "High" }

Response

status:200
Returned if the request is successful.

A successful status:PUT request will not return a response object.

{}

status:400
Returned if the request sent is invalid.

status:404
Returned if the request is not found or the user does not have permission to view it.

Opportunity Attributes

When updating/adding a new opportunity via the API, there are a number of fields needed.

Mandatory Fields

opportunity_type - string
Must be one of Single Car, Single LCV, Multiple Vehicles, Maintenance,Consultancy, Fleet Management, Floorplan Finance, Courtesy Car(s), Asset Finance.

opportunity_status - string
Must be one of your custom Opportunity Statuses.

opportunity_source - string

quality - string
Must be one of High, Medium, Low.

Non Mandatory Fields

opportunity_id - number
Must not be supplied when using status:POST or status:Put .

opportunity_sub_source - string

brand - string
Must be the exact description of a brand in your Accelerate.

description - string

units_car - number

units_lcv - number

value - number

target_close_date - date

close_date - date

account_manager - string
Must be the email address of a valid user in your organisation. If left blank (on either status:POST or status:put ) the opportunity will inherit the account manager of its parent relationship.

tracking_field_1 - string
Max length 1000 characters

tracking_field_2 - string
Max length 1000 characters

tracking_field_3 - string
Max length 1000 characters

tracking_field_4 - string
Max length 1000 characters

tracking_field_5 - string
Max length 1000 characters

loss_reason - string
Must not be supplied when using status:POST or status:Put . Max length 30 characters.

loss_reason - string
Must not be supplied when using status:POST or status:Put . Max length 4000 characters.

Related content