Edit an opportunity

PUT https://api.zenoti.com/v1/opportunities/{opportunity_id}

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.


On this page


Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

PUT /v1/opportunities/{opportunity_id}

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
opportunity_id string Yes Unique identifier of the opportunity.

Request body

Field Type Required Description
center_id string Yes Mandatory Unique identifier of the opportunity
opportunity_title string No Optional Title of the opportunity.
opportunity_description string No Optional Description of the opportunity.
opportunity_owner_id string No Optional Unique Id of the owner of the opportunity.
guest_id string No Optional Unique id of the guest.
created_by_id string No Optional Unique if of the employee.
priority_type_id string No Optional Unique id of the priority type of the opportunity
status_id string No Optional Unique of the stage type (or) status type of the opportunity,
type string No Optional Opportunity type Membership or Package or Others.
followup_date string (date) No Optional Date on which a followup call is planned(yyyy-mm-dd).
expected_close_date string (date) No Optional Expected close date in center time.
listed_amount number (double) No Optional Price listed in the catalog
offered_amount number (double) No Optional Price offered for the opportunity
optional_field1 string No Optional User defined optional field.
optional_field2 string No Optional User defined optional field.
optional_field3 string No Optional User defined optional field.
ticket_id string No Optional Unique id of the ticket.
change_guest_center boolean No Optional boolean which changes guest's center to the valid center_id passed if made true
disposition_id string No Optional Unique id of the disposition
custom_fields string No Optional Key(Guid) has the FieldId of the custom field and Value(String) has the value of the custom field.
lead_source object No Optional Details of lead source

Response

Success (200 OK)

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

Response fields

Field Type Description
success boolean
message string

Example

curl --request PUT \
  --url 'https://api.zenoti.com/v1/opportunities/{opportunity_id}' \
  --header 'Authorization: bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "center_id": "string",
  "opportunity_title": "string",
  "opportunity_description": "string",
  "opportunity_owner_id": "string",
  "guest_id": "string",
  "created_by_id": "string",
  "priority_type_id": "string",
  "status_id": "string",
  "type": "string",
  "followup_date": "2026-01-15",
  "expected_close_date": "2026-01-15",
  "listed_amount": 0,
  "offered_amount": 0,
  "optional_field1": "string",
  "optional_field2": "string",
  "optional_field3": "string",
  "ticket_id": "string",
  "change_guest_center": true,
  "disposition_id": "string",
  "custom_fields": "string",
  "lead_source": {
    "id": "string",
    "code": "string"
  }
}'
const response = await fetch('https://api.zenoti.com/v1/opportunities/{opportunity_id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'bearer {{access_token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  center_id: 'string',
  opportunity_title: 'string',
  opportunity_description: 'string',
  opportunity_owner_id: 'string',
  guest_id: 'string',
  created_by_id: 'string',
  priority_type_id: 'string',
  status_id: 'string',
  type: 'string',
  followup_date: '2026-01-15',
  expected_close_date: '2026-01-15',
  listed_amount: 0,
  offered_amount: 0,
  optional_field1: 'string',
  optional_field2: 'string',
  optional_field3: 'string',
  ticket_id: 'string',
  change_guest_center: true,
  disposition_id: 'string',
  custom_fields: 'string',
  lead_source: { id: 'string', code: 'string' }
})
});
const data = await response.json();
import requests

response = requests.put(
    'https://api.zenoti.com/v1/opportunities/{opportunity_id}',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
    json={'center_id': 'string', 'opportunity_title': 'string', 'opportunity_description': 'string', 'opportunity_owner_id': 'string', 'guest_id': 'string', 'created_by_id': 'string', 'priority_type_id': 'string', 'status_id': 'string', 'type': 'string', 'followup_date': '2026-01-15', 'expected_close_date': '2026-01-15', 'listed_amount': 0, 'offered_amount': 0, 'optional_field1': 'string', 'optional_field2': 'string', 'optional_field3': 'string', 'ticket_id': 'string', 'change_guest_center': True, 'disposition_id': 'string', 'custom_fields': 'string', 'lead_source': {'id': 'string', 'code': 'string'}}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
    JsonSerializer.Serialize(new {
    center_id = "string",
    opportunity_title = "string",
    opportunity_description = "string",
    opportunity_owner_id = "string",
    guest_id = "string",
    created_by_id = "string",
    priority_type_id = "string",
    status_id = "string",
    type = "string",
    followup_date = "2026-01-15",
    expected_close_date = "2026-01-15",
    listed_amount = 0,
    offered_amount = 0,
    optional_field1 = "string",
    optional_field2 = "string",
    optional_field3 = "string",
    ticket_id = "string",
    change_guest_center = true,
    disposition_id = "string",
    custom_fields = "string",
    lead_source = new { id = "string", code = "string" }
}),
    Encoding.UTF8, "application/json");
var response = await client.PutAsync(
    "https://api.zenoti.com/v1/opportunities/{opportunity_id}", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/opportunities/{opportunity_id}')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { center_id: 'string', opportunity_title: 'string', opportunity_description: 'string', opportunity_owner_id: 'string', guest_id: 'string', created_by_id: 'string', priority_type_id: 'string', status_id: 'string', type: 'string', followup_date: '2026-01-15', expected_close_date: '2026-01-15', listed_amount: 0, offered_amount: 0, optional_field1: 'string', optional_field2: 'string', optional_field3: 'string', ticket_id: 'string', change_guest_center: true, disposition_id: 'string', custom_fields: 'string', lead_source: { id: 'string', code: 'string' } }.to_json
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
429 Too many requests -- rate limit exceeded