Q2 2025 Roadmap: Request a beta API key and access upcoming features: Embedded Notifications, Team Communications and more.

Delete a specific break type

DELETE

/api/organizations/{organization_id}/locations/{location_id}/breaks/{id}

locations

Deletes a specific break type by ID for the specified location within the specified organization.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/api/organizations//locations//breaks/'

Response Example

200 - Success

{
  "message": "Break type ID break_type_001 deleted successfully."
}

Request

Path Params

organization_id

string

required

The unique identifier of the organization.

Example:

org_12345

location_id

string

required

The unique identifier of the location.

Example:

loc_001

string

required

The unique identifier of the break type to delete.

Example:

break_type_001

🟢200OK

application/json

The break type was deleted successfully.

Body

message

string

optional

A success message.

Example:

Role deleted successfully.

🟠404Record Not Found