Create Provider Break Series

post

https://connect.agendapro.com/v3/provider_break_repeats

This endpoint creates a recurring series of breaks for one provider.

Responds 202. The series id is returned at once; its breaks are written in the background and appear within seconds. Until then, GET /v3/provider_break_repeats/{id} responds 404.
start_date and end_date bound the first break; its duration is reused for every break of the series.
frequency is xdaily, xweekly or xmonthly; interval repeats every N days, weeks or months. week_days (1 = Monday … 7 = Sunday) is required for xweekly and not allowed otherwise.
Send exactly one of occurrences (up to 366, 53 or 12 by frequency) or until (at most one year away).
A series cannot be updated: delete it and create it again.
Dates follow the local-time convention described in Dates and times.
Errors from platform-services use legacy single-key codes (e.g. provider_not_found, google_event_break), without detail; errors from Connect itself (auth, scope, rate limit) keep {error, detail}.

Status	Error	Detail	Description
400	missing_provider_id		`provider_id` is missing.
400	missing_interval		`interval` is missing.
400	invalid_start_date		`start_date` is not a valid date-time.
400	invalid_end_date		`end_date` is not a valid date-time.
401	unauthorized	invalid_api_key	Missing or invalid Bearer token.
401	unauthorized	api_config_inactive	API access is inactive for this company.
403	forbidden	scope_denied	API key lacks `provider_breaks:write` scope.
404	provider_not_found		The provider does not exist or belongs to another company.
422	invalid_frequency		`frequency` is missing or not one of `xdaily`, `xweekly`, `xmonthly`.
422	missing_week_days		`week_days` is missing for an `xweekly` series.
422	invalid_week_days		`week_days` was sent for a frequency other than `xweekly`.
422	missing_occurrences		Neither `occurrences` nor `until` was sent.
422	invalid_until		Both `occurrences` and `until` were sent, or `until` is more than a year away.
422	invalid_occurrences		`occurrences` is not positive, or exceeds the cap for the frequency.
422	invalid_end_date		`end_date` is not at least one minute after `start_date`.
429	rate_limited	burst_limit_exceeded	Per-minute request limit exceeded.
429	rate_limited	daily_quota_exceeded	Daily request quota exceeded.
502	upstream_unavailable		The upstream service is unavailable.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

202Series accepted; its breaks are written in the background.