FleetDeckDocs

API reference / Touch automations

Delete a touch schedule

Removes the schedule from the list and asks a running occurrence to stop.

DELETE/api/v1/devices/{deviceId}/touch-schedules/{scheduleId}

Authorization

Bearer tokenjobs:write

Send Authorization: Bearer <FLEETDECK_API_KEY> with the scope above. The key must also grant access to the target device. Authentication guide ↗

Request example
Request · cURL
curl --request DELETE \
  --url 'https://fleetdeck.co/api/v1/devices/device_123/touch-schedules/scheduleId' \
  --header "Authorization: Bearer $FLEETDECK_API_KEY"

Replace example IDs with returned values. Read credentials from your private environment.

Response examples
200 · success
{
  "ok": true
}

Path parameters

deviceIdstringrequired

Exact device ID from List devices. The current key must grant access to this phone.

min 1 charactersmax 128 characters
Example: "device_123"
Validation pattern^[A-Za-z0-9._:-]+$
scheduleIdstringrequired

Exact identifier returned by this API, owned by the applicable key/account.

min 1 charactersmax 128 characters
Example: "schedule_123"
Validation pattern^[A-Za-z0-9._:-]+$

Request body

This endpoint does not require a request body.

Behavior and limits

Removes the schedule from the list and asks a running occurrence to stop. Its run history is kept. No request body.

Response 200

Ok · application/json

okbooleanalways present
Allowed:true

Errors

Expand a code for its recovery steps. Responses use error and code; validation errors also include issues.

401UNAUTHORIZEDMissing, malformed, expired or revoked credential; user verification/password state can also deny access.

Recovery: Use Authorization: Bearer with a valid scoped key. For dashboard routes, sign in. Job children require an active parent job and timely renewal.

Full error reference ↗
403FORBIDDENRequired scope, device grant, account membership or worker identity is missing.

Recovery: Check the endpoint’s scopes, exact device, owning key and workerId. A different key cannot access the original key’s sessions or jobs.

Full error reference ↗
404NOT_FOUNDUnknown route or resource unavailable to this caller.

Recovery: Check method/path and use returned IDs from this account/key. Do not guess IDs.

Full error reference ↗
402PLAN_REQUIREDDevice account has no active entitlement.

Recovery: Restore an active device entitlement in the workspace before controlling it.

Full error reference ↗
400INVALID_SCHEDULEThe schedule time, cron, timezone, failure email or saved sequence was rejected by the touch scheduler (a foreign failure email returns HTTP 422 with this code).

Recovery: Use five numeric cron fields or a runAt 30 seconds to one year ahead, a valid IANA timezone, a workspace member email and a sequence saved on this phone.

Full error reference ↗
409SCHEDULE_CONFLICTThe touch scheduler refused the change in the schedule’s current state (for example resuming is needed first, or the occurrence already ran).

Recovery: Read the message, list the schedules again and apply the change that matches the current state.

Full error reference ↗
503UNAVAILABLETouch schedules are not configured on this server.

Recovery: Use the hosted FleetDeck API or configure the touch scheduler service.

Full error reference ↗
500INTERNALUnexpected service error.

Recovery: Save nonsecret request context and time for support. Query action status before repeating a mutation; never assume it did not execute.

Full error reference ↗

Example error messages are illustrative. Match the code and HTTP status; do not depend on exact message wording.