Skip to content
Pidgely Docs

API reference · Automations

Delete an automation

DELETEhttps://api.pidgely.com/automations/{id}
View as Markdown

Deletes an automation. Customers in it leave (deleted); its templates stay in Templates.

Deletes an automation; its live enrollments end (deleted). Its templates stay in Templates. Admins and owners. Needs a plan with automations (Scale or custom; 403 plan_required otherwise).

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Automation id. UUID.

Request

This endpoint is not in the SDKs yet; call it over HTTP.

cURL
curl -X DELETE 'https://api.pidgely.com/automations/0199e1a0-2b4c-7d6e-8f01-2a3b4c5d6e7f' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "automation",
  "id": "0199e1a0-2b4c-7d6e-8f01-2a3b4c5d6e7f",
  "deleted": true
}

Response fields

Name Type Required Description
object string Yes Object type.
id string Yes Unique id (UUID). UUID.
deleted boolean Yes —

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.
403 plan_required The organization is below the Scale plan (field is automations).