Request schema for creating a provider
Request schema for creating a provider
Example
SavvyCal Appointments{ "add_user": true, "display_name": "John Smith", "email": "john.smith@tendermedical.com", "first_name": "John", "last_name": "Smith", "metadata": { "external_id": "123" }, "notify": false, "role_ids": [ "role_123456789012" ], "time_zone": "America/New_York"}Whether to grant the provider access to the dashboard.
falseThe provider's display name.
The provider's email address.
The provider's first name.
The provider's initial schedule, created atomically with the provider when a brand-new provider row is created (ignored on reactivation or affiliation of an existing provider). All fields are optional. Omit the object or pass null for no schedules; an empty object {} still creates a schedule with effective_from defaulted to yesterday and no weekly rules.
Example
{ "effective_from": "2025-01-01", "effective_to": "2025-12-31", "public_bookings": { "enabled": true }, "time_zone": "America/New_York", "weekly_rules": [ { "day": "mo", "end_time": "17:00", "start_time": "09:00" } ]}The provider's last name.
Set of key-value pairs to attach to this provider. Maximum size is 16 KB.
Whether to send an email notification to the user (if add_user is true). If they don't already have an account, they will receive an email with instructions to set their password when this property is true.
falseList of role IDs to assign to the user (if add_user is true).
The provider's preferred IANA time zone, used as the default when authoring schedules. Defaults to the account location's time zone when omitted.
"America/New_York"