Delete member scheduled action

DELETE /api/members/{memberId}/scheduled-actions/{all}

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

Overview

Cancels one scheduled action belonging to a member. A scheduled action is a change to the member that has been diarised for a future date — a move to a different price level, a change of status, or a transfer to a different site. Deleting the record cancels the change; it does not undo anything, because the action has not been applied yet.

Actions raised as part of a membership freeze are stored the same way, so deleting one cancels the freeze transition it was raised for.

You need the action's own id, which you get from Retrieve a member's future scheduled actions. The action must belong to the member in the path — a mismatch is not silently ignored; the endpoint returns 400.

A successful call returns 204 No Content. This endpoint only manages the schedule; the changes themselves are applied separately at a later time, so cancel the action before its date if you want to prevent it taking effect.

Endpoint

DELETE {base_url}/api/members/{memberId}/scheduled-actions/{all}

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

Path parameters

Name	Type	Required	Description
`memberId`	integer (int32)	Yes	The member the scheduled action belongs to. Must be greater than `0` — `0` (non-member) and `-999` (purged member) are rejected with `400`. When you call with a member-scoped token this must be the member the token was issued for, or you get `403`.
`id`	integer (int32)	Yes	The scheduled action to cancel, supplied as the final path segment. This is the action id returned as `id` by Retrieve a member's future scheduled actions — not the member id, and not the price level, status or site the action targets. It must be an action owned by `memberId`; an action id that exists but belongs to someone else is rejected with `400` rather than deleted.

Sample request

cURL

curl -X DELETE '{base_url}/api/members/{memberId}/scheduled-actions/{all}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

Status	Meaning	When
`400`	Bad request	The action exists but belongs to a different member. The body is `The actionId : {id} does not belong to memberId : {memberId}. The Scheduled Action must belong to the specified Member.`
`400`	Bad request	`memberId` is `0` or negative. The body is `{memberId} is an invalid member ID`.
`403`	Forbidden	The token identifies a specific member and `memberId` is not that member. The body is `The given member ID of {memberId} does not belong to the logged in member`.
`404`	Not found	`memberId` does not exist. The body is `MemberId : {memberId} could not be found`. Member existence is checked first, so you never see the action-level `404` for an unknown member.
`404`	Not found	No scheduled action with that id exists at all. The body is `ActionId : {id} could not be found`. Deleting an action that has already been deleted therefore gives `404`, not a silent success.
`500`	Internal server error	An unexpected server-side failure while validating or deleting the action.

This page as markdown · All pages · llms.txt