Create Provider

This endpoint creates a service provider (a staff member who takes bookings) in a location of the company.

Important Notes

  • location_id and public_name are required. The location must belong to the company.
  • online_booking defaults to true.
  • times sets the working hours, one entry per working day, each with optional breaks. Days not listed are days off.
  • Hours are not validated against the location's opening hours.
  • The company is taken from the API key; company_id is never accepted.
  • Plan limits on active providers are enforced by the upstream service.

Errors Dictionary

StatusErrorDetailDescription
400invalid_bodyexpected_objectRequest body is not a JSON object.
400missing_*—A required field is missing (location_id, public_name).
400provider_time_is_not_rounded—A time is not rounded to 5-minute intervals.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks providers:write scope.
422public_name_too_long—public_name exceeds 255 characters.
422provider_time_closes_before_open—A closing time is not after its opening time.
422overlapping_provider_times—Two time ranges overlap on the same day.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Fields accepted when creating a provider. The company comes from the API key.

integer
required

Location of the provider. Must belong to the company.

string
required
length ≤ 255

Name shown on the calendar and the booking site.

boolean

Whether clients can book the provider online. Defaults to true.

string | null

Biography shown on the booking site.

times
array of objects

Working hours, one entry per working day.

times
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json