Automations
Enroll contact into automation
Enroll a contact into an active automation by email. The contact must already exist in the workspace. 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.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://api.keplars.com/api/v1/public/automations/add-automation/497f6eca-6276-4993-bfeb-53cbbbba6f08/enroll" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]" }'{
"success": true,
"message": "Success"
}{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Field 'to' is required"
}{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Field 'to' is required"
}