v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Edit an opportunity

Supply the unique identifier of the opportunity as opportunity_id and send the original request body with intended changes for the API to update particular opportunity.

put/v1/opportunities/{opportunity_id}

Path parameters

opportunity_idstring required

Unique identifier of the opportunity.

Request body

center_idstring required

Mandatory Unique identifier of the opportunity

opportunity_titlestring

Optional 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

Optional Unique id of the guest.

created_by_idstring

Optional Unique if of the employee.

priority_type_idstring

Optional Unique id of the priority type of the opportunity

status_idstring

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

typestring

Optional Opportunity type Membership or Package or Others.

followup_datestring date

Optional Date on which a followup call is planned(yyyy-mm-dd).

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_field1string

Optional User defined optional field.

optional_field2string

Optional User defined optional field.

optional_field3string

Optional User defined optional field.

ticket_idstring

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.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Opportunity Updated Successfully"
}