Manage opportunities using APIs
The opportunities workflow lets you create and manage sales leads through the Zenoti API. An opportunity represents a potential customer who could purchase a service, product, membership, or package. You can use the API to track leads, manage the sales pipeline, and attach notes to opportunity records.
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.
Steps
Step 1: Locate the guest
Use the Search for a Guest API to find the guest associated with the opportunity. If the guest does not exist in Zenoti, use the Create a Guest API to create a new guest record.
Step 2: Retrieve opportunity metadata
Use the Retrieve Opportunity Configuration API to get the available opportunity types, stages, and other configuration metadata for your organization. This information is needed when creating an opportunity.
Step 3: Create an opportunity
Use the Create an Opportunity API to create a new sales lead with the guest, opportunity type, and initial stage.
Step 4: Manage the opportunity
After creating the opportunity, use these operations to manage it through the sales pipeline:
- Retrieve an opportunity. Use the Retrieve an Opportunity API to get the current details and status.
- List opportunities. Use the List Opportunities API with pagination to view all opportunities in the system.
- Edit an opportunity. Use the Edit an Opportunity API to update the stage, status, or other details as the lead progresses.
- Attach notes. Use the Create an Opportunity Note API to add notes with context about interactions, follow-ups, or outcomes.
- View notes. Use the Retrieve Opportunity Notes API to review the history of notes attached to an opportunity.
Tips
- Use opportunities to track leads when memberships or packages are expiring, so your team can proactively reach out to guests for renewal.
- Attach notes at each stage of the sales pipeline to maintain a clear record of interactions.
- Use the List Opportunities API with filters and pagination to build custom sales dashboards.