Keplars
Get Started
Automations

Unenroll contact from automation

DELETE
/api/v1/public/automations/delete-automation/{id}/subscribers

Remove a contact from an active automation. Requires automations:write scope.

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication. Use a Regular API key for email sending, or an Admin API key for marketing and automation endpoints.

Get your API keys from Settings → API Keys (regular) or Settings → Admin API Keys (admin) in the dashboard.

In: header

Path Parameters

id*string

Automation ID.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X DELETE "https://api.keplars.com/api/v1/public/automations/delete-automation/497f6eca-6276-4993-bfeb-53cbbbba6f08/subscribers" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]"  }'
{
  "success": true,
  "message": "Success"
}
{
  "success": false,
  "error": "VALIDATION_ERROR",
  "message": "Field 'to' is required"
}

List automations GET

Returns all automations in your workspace. Requires `automations:read` scope.

Add custom domain POST

Register a custom sending domain and receive the DNS records required for verification. Requires `domains:manage` scope. After adding the domain, poll `GET /api/v1/public/domains/domain-status/{domainID}` until `verification_status` is `verified`.