Delete a scheduled communication job
DELETE /api/communications/schedule-job/{id}
- Products: Operator (
FOH) - Features: Front of House Generic Access (
FOHGENERIC)
Overview
Cancels a scheduled communication job — the record that says "send this email, SMS or push notification to this audience, at this time or on this recurrence".
Deletion is asynchronous. A 204 means the request was accepted, not that the job has gone. The job is first marked as pending deletion and a message is sent to the background scheduler to cancel its pending run; the job record, its recurrence and its queued events are removed after that completes. Expect a short window in which the job still appears in a listing, and treat the 204 as "cancellation started".
There is no undo, and no request body — the job is identified entirely by the path. Deleting a job stops future runs only; messages already sent are unaffected, and the delete does not remove the record of what was sent.
Endpoint
DELETE {base_url}/api/communications/schedule-job/{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 communication job to cancel, as returned when the job was created. Must be 1 or greater. Once the deletion has finished, repeating the call with the same id returns 404. |
Sample request
curl -X DELETE '{base_url}/api/communications/schedule-job/{id}' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true'Errors
| Status | Meaning | When |
|---|---|---|
400 | Bad request | id is zero or negative (DeleteScheduledJob must be a valid, positive number), or the path segment is not an integer. |
404 | Not found | No communication job holds that id (Communication job {id} doesn't exist) — including a job whose deletion has already completed. |
409 | Conflict | Other records still reference the job, so it cannot be deleted (Unable to delete the scheduled job with Id {id}.). |
500 | Internal server error | A concurrency failure, or any other unexpected error while marking the job for deletion. The response has no body. |