Overview
The Professional Settings API allows you to retrieve and update configuration settings for professionals in the Zenda system. These settings control availability, session parameters, payment requirements, and other preferences.Base Endpoint
Available Endpoints
Get Settings
Retrieve current professional settings
Update Settings
Update professional configuration
Settings Object
Professional settings include the following configuration:Configuration Parameters
Session Duration
- Range: 15 to 180 minutes
- Purpose: Defines how long each appointment session lasts
- Example: 60 minutes for a standard consultation
Work Schedule
- work_days: String representing available days (format varies by implementation)
- work_start_time: When the professional starts accepting appointments
- work_end_time: When the professional stops accepting appointments
Reservation Window
- Range: 1 to 365 days
- Purpose: How far in advance clients can book appointments
- Example: 30 days means clients can book up to 30 days ahead
Payment Settings
- requires_deposit: Whether payment is required to book
- deposit_amount: Amount required if deposits are enabled (can be null)
Session Modalities
Professionals can offer sessions in different formats:Virtual- Online/remote sessions onlyPresencial- In-person sessions onlyBOTH- Both virtual and in-person options available
Office Address
- Optional field for in-person session locations
- Required if offering
PresencialorBOTHmodalities
Authentication
All professional settings endpoints require Bearer token authentication. Some endpoints also require specific roles.Use Cases
- Configure professional availability and schedule
- Set session duration and booking windows
- Enable or disable payment requirements
- Define session types (virtual vs in-person)
- Update office location for in-person sessions
Next Steps
Get Settings
Learn how to retrieve settings
Update Settings
Learn how to update configuration