Delete Provider Break Series

This endpoint deletes a series and all its breaks, past and future.

Important Notes

  • Only series of a single provider can be deleted through the API. Series created in Agenda Pro for several providers respond 422.
  • A series with more than 1000 breaks cannot be deleted through the API.

Errors Dictionary

StatusErrorDetailDescription
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_repeat_not_foundSeries not found, its breaks are still being written, or it has breaks of another company.
422several_providers_seriesThe series has breaks of more than one provider.
422invalid_occurrencesThe series has more than 1000 breaks.
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 series unique identifier.

Responses
204

Series and its breaks deleted.

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