ZenotiHelp

Use opportunity APIs

ZTZenoti Docs Team Updated March 7, 2026 1 min readGuide

The opportunity APIs let you create and manage sales leads, track opportunities through the pipeline, and attach notes to opportunity records. An opportunity represents a potential customer who could purchase a service, product, membership, or package.

For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.

Before you begin

  • You need a valid API key or access token. See Set up API authentication.
  • Opportunity configuration must be set up in your Zenoti organization.

Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.

Opportunity operations

Create an opportunity

POST /v1/opportunities

Creates a new sales lead with guest, opportunity type, and stage information.

Retrieve an opportunity

GET /v1/opportunities/{opportunity_id}

Retrieves details of a specific opportunity.

Parameter Type Required Description
opportunity_id guid Yes Opportunity identifier

List all opportunities

GET /v1/opportunities

Retrieves all opportunities with pagination support.

Edit an opportunity

PUT /v1/opportunities/{opportunity_id}

Updates an existing opportunity's stage, status, or other details.

Parameter Type Required Description
opportunity_id guid Yes Opportunity identifier

Opportunity notes

Add notes to an opportunity

POST /v1/opportunities/{opportunity_id}/notes

Adds a note to an opportunity record.

Parameter Type Required Description
opportunity_id guid Yes Opportunity identifier

List opportunity notes

GET /v1/opportunities/{opportunity_id}/notes

Retrieves all notes attached to an opportunity.

Parameter Type Required Description
opportunity_id guid Yes Opportunity identifier

Response: Array of notes with id, value (note content), updated_by_id, creation_date.

Tips

  • Use opportunity notes to document interactions, follow-ups, and outcomes at each stage of the sales pipeline.
  • Retrieve the opportunity configuration before creating opportunities to get valid types, stages, and metadata.
  • Combine opportunity APIs with guest APIs for a complete lead management workflow.

API reference

Was this article helpful?
Your feedback helps us improve our documentation.