EmailOctopus logo

API > Start an automation for a contact


Start an automation for a list contact. The automation must have the 'Started via API' trigger type. An automation may only be started once per contact.

api_key (string) Your API key.
list_member_id (string) The ID of the list contact.
200 (success) returns
Non-200 (error) returns

Details of the error:

code (string) The error code.
message (string) A description of the error.
Method-specific error codes
CONTACT_NOT_FOUND The contact was not found.
AUTOMATION_NOT_FOUND The automation was not found.
ALREADY_STARTED The automation was already started for this contact.
API-wide error codes
INVALID_PARAMETERS Parameters are missing or invalid.
API_KEY_INVALID Your API key is invalid.
UNAUTHORISED You're not authorised to perform that action.
NOT_FOUND The requested endpoint does not exist.
UNKNOWN An unknown error has occurred.
Example request
    "api_key": "00000000-0000-0000-0000-000000000000",
    "list_member_id": "11111111-1111-1111-1111-111111111111"

Example response
Code sample