Delete pricing timeband

DELETE /api/configuration/timebands/{timebandId}

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Removes a pricing timeband — a named period of the day, such as peak or off-peak, that prices and entry restrictions are attached to.

This is a hard delete, and it takes the timeband's translations with it. The timeband is removed, and then every translated description recorded against that timeband, in every language, is deleted. There is no soft-delete or inactive flag, and nothing is returned that would let you undo it.

A timeband still referenced by pricing returns 409, not 400 or 500. There is no up-front check; the delete is attempted and refused with 409 and the body There are records linked to the ID {timebandId} that are stopping the operation being completed. Nothing is deleted. Clear the references first — this endpoint will not cascade for you.

The delete does not check that the timeband exists before removing it. An unknown identifier is reported as 404 with an empty body. That makes a repeat call return 404 rather than acting as a no-op, and on a retry 404 means the first attempt succeeded.

On success, a subsequent read is up to date.

Endpoint

DELETE {base_url}/api/configuration/timebands/{timebandId}

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Name	Type	Required	Description
`timebandId`	string	Yes	The timeband code, as returned by the retrieve-timebands endpoints. Timebands created without an explicit identifier are given one prefixed `TBND`; identifiers you supply on create are upper-cased and stripped of spaces before being stored, so use the stored form here — the delete does no normalising of its own and an identifier that does not match exactly returns `404`.

Sample request

cURL

curl -X DELETE '{base_url}/api/configuration/timebands/{timebandId}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

Status	Meaning	When
`400`	Bad request	`timebandId` is empty — `Id cannot be null or empty`. In practice a request with an empty path segment does not reach this endpoint.
`404`	Not found	No timeband has that identifier — it never existed, its case or spacing does not match the stored value, or a previous call already deleted it. The body is empty.
`409`	Conflict	Something still references the timeband, typically pricing records, and blocks the removal — `There are records linked to the ID {timebandId} that are stopping the operation being completed`. Nothing is deleted; remove the references and call again.
`500`	Internal server error	The delete failed for a reason other than a linked record or a missing timeband. The body is empty.

This page as markdown · All pages · llms.txt