Q3 Roadmap: Embedded Notifications, Embedded Commissions, Tips and more!

Update a specific break type

PATCH

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

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/organizations//locations//breaks/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Updated Lunch Break",
    "durationMinutes": 45,
    "frequencyMinutes": 300,
    "paid": true,
    "mandatory": false,
    "enabled": false
}'

Response Example

200 - Success

{
    "id": "break_type_001",
    "name": "Updated Lunch Break",
    "locationId": "loc_001",
    "durationMinutes": 45,
    "frequencyMinutes": 300,
    "paid": true,
    "mandatory": false,
    "active": true,
    "enabled": false,
    "createdAt": "2023-10-27T09:00:00Z",
    "updatedAt": "2023-10-27T11:00:00Z",
    "deletedAt": null
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

The break type was updated successfully.

Body

🟠400Bad Request

🟠404Record Not Found

Modified at 2025-03-23 09:54:33

Create a new break type for a location

Delete a specific break type