Update Provider Break

This endpoint partially updates a provider break. Only the fields present in the request body are modified.

Important Notes

  • Breaks synced from Google Calendar (editable: false) cannot be updated.
  • A break that belongs to a recurring series or is shared by several providers becomes independent when updated: later changes to the series or the shared break made in Agenda Pro no longer apply to it, the same as when it is moved in the calendar.
  • 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}.

Errors Dictionary

StatusErrorDetailDescription
400invalid_start_datestart_date is not a valid date-time.
400invalid_end_dateend_date is not a valid date-time.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks provider_breaks:write scope.
404provider_break_not_foundProvider break not found, or it belongs to another company.
422google_event_breakThe break is synced from Google Calendar.
422invalid_end_dateThe resulting end_date is not at least one minute after start_date.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Provider break unique identifier.

Body Params
string
date-time

Local time of the location written with Z (see Dates and times).

date-time

Local time of the location written with Z (see Dates and 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