Delete a business rule
DELETE /api/business-rules/{id}
- Products: Operator (
FOH) - Features: Front of House Generic Access (
FOHGENERIC)
Overview
Permanently removes a business rule, so it stops firing the moment the call succeeds. There is no
undo. If you only want the automation to stop for a while, set isActive to false with
Update details for a business rule
instead — an inactive rule is skipped when its trigger fires but can be switched back on.
The email templates and webhooks the rule referenced are not affected; they are referenced by id
and go on existing after the rule that used them. On success the endpoint returns 204 No Content
with an empty body.
Find the id to pass here with List all business rules.
Endpoint
DELETE {base_url}/api/business-rules/{id}
{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | integer (int32) | Yes | The business rule to delete, as returned in [].id by List all business rules or in the body of Create a new business rule. An id that matches no rule is rejected with Business Rule Id {id} does not exist., so a repeated delete returns 404 rather than succeeding silently. |
Sample request
curl -X DELETE '{base_url}/api/business-rules/{id}' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true'Errors
| Status | Meaning | When |
|---|---|---|
400 | Bad request | This endpoint does not return 400 — a value that is not an integer does not match this endpoint's path, and an integer that matches no rule returns 404. |
404 | Not found | No rule has that id — Business Rule Id {id} does not exist. Either it was never created, or it has already been deleted. |
500 | Internal server error | An unexpected server-side failure while removing the rule; the body is empty. |