Create an opportunity

post

https://api.zenoti.com/v1/opportunities

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

Recipes

🦉

Create an opportunity in sales module

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns

The response contains a variable success which represents whether the creation is successful or not and newly created opportunity id is returned as opportunity_id

Query Params

center_id

string

required

Mandatory Unique identifier of the opportunity

opportunity_title

string

required

Mandatory Title of the opportunity.

opportunity_description

string

Optional Description of the opportunity.

opportunity_owner_id

string

Optional Unique Id of the owner of the opportunity.

guest_id

string

required

Mandatory Unique id of the guest.

created_by_id

string

required

Mandatory Unique is of the employee.

priority_type_id

string

Optional Unique id of the priority type of the opportunity

status_id

string

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

type

string

Optional Opportunity type Membership or Package or Others

NOTE: This parameter is required to use Sales Stage Rules.

Steps to create/edit opportunity type: Forms->Forms Creation->Custom List->Opportunity Type

followup_date

date

required

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

expected_close_date

date

Optional Expected close date in center time.

listed_amount

double

Optional Price listed in the catalog

offered_amount

double

Optional Price offered for the opportunity

optional_field_1

string

Optional User defined optional field.

optional_field_2

string

Optional User defined optional field.

optional_field_3

string

Optional User defined optional field.

ticket_id (guid)

string

Optional Unique id of the ticket.

change_guest_center

boolean

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

disposition_id

string

Optional Unique id of the disposition

custom_fields

string

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

lead_source

string

Optional Details of lead source

lead_source.id

string

Optional Unique id of the lead source

lead_source.code

string

Optional Code of the lead source

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Returns

200200

400400