Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Create an opportunity

Supply the opportunity object in the request body and this API will create an opportunity with given details. <br/> Note: 'type' parameter is required to use Sales Stage Rules. <br/>Steps to create/edit Sales Stage Rules - Opportunities-> Sales Stage Rules.

post/v1/opportunities

Query parameters

center_idstring required

Mandatory Unique identifier of the opportunity

opportunity_titlestring required

Mandatory Title of the opportunity.

opportunity_descriptionstring

Optional Description of the opportunity.

opportunity_owner_idstring

Optional Unique Id of the owner of the opportunity.

guest_idstring required

Mandatory Unique id of the guest.

created_by_idstring required

Mandatory Unique is of the employee.

priority_type_idstring

Optional Unique id of the priority type of the opportunity

status_idstring

Optional Unique id the stage type (or) status type of the opportunity,

typestring

Optional Opportunity type Membership or Package or Others <br/><p style='color:red'>NOTE: This parameter is required to use Sales Stage Rules.</p><p>Steps to create/edit opportunity type: Forms->Forms Creation->Custom List->Opportunity Type</p>

followup_datestring date required

Mandatory Date on which a followup call is planned(yyyy-mm-dd) in center time.

expected_close_datestring date

Optional Expected close date in center time.

listed_amountnumber double

Optional Price listed in the catalog

offered_amountnumber double

Optional Price offered for the opportunity

optional_field_1string

Optional User defined optional field.

optional_field_2string

Optional User defined optional field.

optional_field_3string

Optional User defined optional field.

ticket_id (guid)string

Optional Unique id of the ticket.

change_guest_centerboolean

Optional Boolean which changes guest's center to the valid center_id passed if made true

disposition_idstring

Optional Unique id of the disposition

custom_fieldsstring

Optional Key(Guid) has the FieldId of the custom field and Value(String) has the value of the custom field.

lead_sourceobject

Optional Details of lead source

lead_source.idstring

Optional Unique id of the lead source

lead_source.codestring

Optional Code of the lead source

Response

200

successboolean
opportunity_idstring
messagestring

Example response

{
  "success": true,
  "opportunity_id": "ae0df9db-908b-4169-aca0-756b879df4f2",
  "message": "Opportunity Created Succesfully"
}