A journey is an automation: a trigger, then steps such as waits, emails, tags, webhooks and branches. All commands take APIKey. They use the /api/v1/ paths shown, and /api.php with Command works too. Errors use the Errors array format. Code 0 means success.
Subscribers in journeys
subscriber.journey.trigger
Starts one subscriber in one or more journeys. POST /api/v1/subscriber.journey.trigger. Use it with the Manual (API) trigger.
| Parameter | Type | Required | Description |
|---|---|---|---|
JourneyID |
int or array | Yes | One journey or several |
ListID |
int | Yes | |
SubscriberID |
int | Yes | |
BypassJourneyStatusCheck |
bool | No | Start the journey even if it is off. Default false |
curl https://app.emailmarketer.io/api/v1/subscriber.journey.trigger \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyID": 789, "ListID": 123, "SubscriberID": 456 }'
{ "Success": true, "JourneyIDs": [789], "ListID": 123, "SubscriberID": 456 }
When some journeys are skipped, the response adds SkippedJourneys with a Reason for each.
| Code | Meaning |
|---|---|
| 1, 2, 3 | Missing JourneyID, ListID or SubscriberID |
| 4, 5, 6 | Invalid JourneyID, ListID or SubscriberID |
| 7 | Every journey was skipped |
| 8 | List not found |
| 9 | Subscriber not found |
Other subscriber commands
| Command | Path | Required | Returns |
|---|---|---|---|
subscriber.journey.remove |
POST /api/v1/subscriber.journey.remove |
JourneyID (int or array), ListID, SubscriberID |
As trigger |
subscriber.journey.exit |
POST /api/v1/subscriber.journey.exit |
JourneyID, ListID, SubscriberID |
JourneyID, ListID, SubscriberID. Error 7 means the journey was not found |
subscriber.journey.list |
POST /api/v1/subscriber.journey.list |
ListID, SubscriberID |
Journeys (JourneyID, JourneyName, Status, JoinedAt) |
Examples:
# subscriber.journey.remove
curl https://app.emailmarketer.io/api/v1/subscriber.journey.remove \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyID": 789, "ListID": 123, "SubscriberID": 456 }'
# subscriber.journey.exit
curl https://app.emailmarketer.io/api/v1/subscriber.journey.exit \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyID": 789, "ListID": 123, "SubscriberID": 456 }'
# subscriber.journey.list
curl https://app.emailmarketer.io/api/v1/subscriber.journey.list \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "ListID": 123, "SubscriberID": 456 }'
subscribers.journey.bulk
Enrols or removes many subscribers in the background. POST /api/v1/subscribers.journey.bulk.
| Parameter | Required | Description |
|---|---|---|
ListID |
Yes | |
JourneyID |
Yes | |
Mode |
Yes | enroll or unenroll |
SegmentID |
No | Only this segment |
RulesJSON, Operator |
No | Only subscribers who match rules. Not with SegmentID or SearchQuery |
SearchQuery |
No | Match email addresses, up to 255 characters |
With none of the filters, the whole list is used. Subscribers already active in the journey are skipped. enroll needs a journey that is on.
curl https://app.emailmarketer.io/api/v1/subscribers.journey.bulk \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "ListID": 123, "JourneyID": 789, "Mode": "enroll", "SegmentID": 456 }'
{ "Success": true, "ErrorCode": 0, "Mode": "enroll", "ListID": 123, "JourneyID": 789, "MatchingSubscribers": 4812, "Queued": true }
Errors: 1 to 11 validation (HTTP 422), 12 list not found (404), 13 journey not found (404), 14 journey is off (422), 15 segment not found (404), 16 and 17 server errors (500).
journey.create
POST /api/v1/journey. New journeys start off.
| Parameter | Required | Description |
|---|---|---|
Name |
Yes | |
Trigger |
No | Manual (default), ListSubscription, ListUnsubscription, EmailOpen, EmailLinkClick, EmailConversion, Tag, UnTag, CustomFieldValueChanged, RevenueHit, JourneyCompleted, ScheduledPull, WebsiteEvent_pageView, WebsiteEvent_identify, WebsiteEvent_customEvent, WebsiteEvent_conversion |
Trigger_ListID |
Depends on trigger | The list the trigger watches |
Trigger_EmailID |
Depends on trigger | The email for open, click and conversion triggers |
Trigger_Value |
Depends on trigger | For example the tag ID |
TriggerParameters |
For ScheduledPull |
Interval, how many subscribers per run, allowed days and hours, time zone and frequency cap |
Trigger_Criteria, Run_Criteria, Run_Criteria_Operator |
No | Who may enter |
Rate_Limit_Per_Hour, Rate_Limit_Per_Day |
No | Cap how many subscribers enter |
Notes |
No |
curl https://app.emailmarketer.io/api/v1/journey \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "Name": "Welcome series", "Trigger": "ListSubscription", "Trigger_ListID": 123 }'
{ "JourneyID": 456, "Journey": { "JourneyID": "456", "JourneyName": "Welcome series", "Trigger": "ListSubscription", "Status": "Disabled" } }
| Code | Meaning |
|---|---|
| 1 | Missing Name |
| 3 | Invalid trigger |
| 4 to 6 | Trigger_ListID missing, invalid or not found |
| 7 to 9 | Trigger_EmailID missing, invalid or not found |
| 10, 11 | Trigger_Value invalid or not found |
| 12 to 17 | Invalid value for the custom field, revenue or journey-completed trigger |
| 18, 19 | Invalid hourly or daily limit |
| 20, 21, 24 | Invalid scheduled pull list or time zone |
journey.actions.update
Sets a journey’s steps. PATCH /api/v1/journey.actions, JSON body. Requires JourneyID and Actions, an array of step objects. Each step has ActionID (null for a new step), Action, Published and Notes, plus its own fields:
Action |
Fields |
|---|---|
Wait |
WaitUnit, WaitAmount, TimeConstraintEnabled, DontSendBefore, DontSendAfter, AllowedDays |
SendEmail |
EmailID, SenderDomainID, From (Name, Email), ReplyTo, CC, BCC |
Decision |
CriteriaOperator, Criteria, Actions.True, Actions.False |
AddTag, RemoveTag |
TargetTagID |
Subscribe, Unsubscribe |
TargetListID |
UpdateCustomFieldValue |
TargetCustomFieldID, NewCustomFieldValue |
Webhook |
WebhookURL. Must be a public http or https address |
StartJourney |
TargetJourneyID |
ExitJourney |
TargetJourneyID (int or array) |
ExitThisJourney, ExitAllOtherJourneys, ExitAllJourneys, DeleteSubscriber |
none |
curl -X PATCH https://app.emailmarketer.io/api/v1/journey.actions \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyID": 789, "Actions": [{ "ActionID": null, "Action": "AddTag", "Published": true, "Notes": "Tag as onboarded", "TargetTagID": 789 }] }'
Every reference is checked before anything is saved. A refused call changes nothing.
Errors: 1 missing JourneyID, 2 missing Actions, 3 invalid JourneyID, 4 Actions is not an array, 5 journey not found, 6 invalid step type, 7 to 9 invalid From, 10 and 11 invalid decision field, 12 to 17 a referenced email, domain, list, tag, journey or field was not found, 18 invalid webhook URL, 19 From address not allowed.
PATCH /api/v1/journey.actions.published publishes or unpublishes steps. It takes JourneyID and Actions as [{ "actionid": 1, "published": true }].
Read and manage
| Command | Method and path | Required | Optional |
|---|---|---|---|
journey.get |
GET /api/v1/journey |
JourneyID |
StartDate, EndDate (YYYY-MM-DD, default last 30 days), IncludeActivityCounters, EmailID, ISP |
journey.list |
GET /api/v1/journeys |
none | StatsStartDate, StatsEndDate, SkipStats, IncludeActivityCounters |
journey.update |
PATCH /api/v1/journey |
JourneyID |
Same fields as create |
journey.enable |
GET /api/v1/journey.enable |
JourneyID |
none |
journey.disable |
GET /api/v1/journey.disable |
JourneyID |
none |
journey.clone |
POST /api/v1/journey.clone |
JourneyID, NewJourneyName |
none. The copy is off |
journey.delete |
POST /api/v1/journey.delete |
JourneyID |
none |
journeys.enable, journeys.disable, journeys.clone |
POST /api/v1/journeys.enable (and so on) |
JourneyIDs (comma-separated) |
NameSuffix for clone. Returns ProcessedJourneyIDs and FailedJourneyIDs |
journeys.delete |
POST /api.php |
Journeys (comma-separated) |
none |
journey.sendemailactions |
GET /api/v1/journey.sendemailactions |
none | JourneyID, IncludeDisabled, IncludeUnpublished |
Examples:
# journey.get
curl -G https://app.emailmarketer.io/api/v1/journey \
-d APIKey="$EM_API_KEY" \
-d JourneyID=789 \
-d StartDate=2026-11-01
# journey.list
curl -G https://app.emailmarketer.io/api/v1/journeys \
-d APIKey="$EM_API_KEY" \
-d SkipStats=true
# journey.update
curl -X PATCH https://app.emailmarketer.io/api/v1/journey \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyID": 789, "Name": "Welcome series v2" }'
# journey.enable
curl -G https://app.emailmarketer.io/api/v1/journey.enable \
-d APIKey="$EM_API_KEY" \
-d JourneyID=789
# journey.disable
curl -G https://app.emailmarketer.io/api/v1/journey.disable \
-d APIKey="$EM_API_KEY" \
-d JourneyID=789
# journey.clone
curl https://app.emailmarketer.io/api/v1/journey.clone \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyID": 789, "NewJourneyName": "Welcome series copy" }'
# journey.delete
curl https://app.emailmarketer.io/api/v1/journey.delete \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyID": 789 }'
# journeys.enable
curl https://app.emailmarketer.io/api/v1/journeys.enable \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'", "JourneyIDs": "789,790" }'
# journeys.delete
curl https://app.emailmarketer.io/api.php \
-d Command=journeys.delete \
-d APIKey="$EM_API_KEY" \
-d Journeys=789,790
# journey.sendemailactions
curl -G https://app.emailmarketer.io/api/v1/journey.sendemailactions \
-d APIKey="$EM_API_KEY" \
-d JourneyID=789
journey.enable and journey.disable return error 4 when the journey is already in that state. Bad dates return HTTP 422.
Reports
| Command | Path | Required | Returns |
|---|---|---|---|
journey.stats.byaction |
GET /api/v1/journey.stats.byaction |
JourneyID |
Results per step, with daily figures |
journey.stats.byisp |
GET /api/v1/journey.stats.byisp |
JourneyID |
Sent, delivered, opened, clicked, bounced, unsubscribed and complained per mailbox domain |
journey.action.subscribers |
GET /api/v1/journey.action.subscribers |
JourneyID, ActionID |
Subscribers an email step reached. Filter with Filter (opened, clicked, converted, forwarded, unsubscribed, bounced, spam_complaint) |
account.journey.benchmark |
GET /api/v1/account.journey.benchmark |
none | Account-wide open, click, bounce, unsubscribe and complaint rates as decimals |
journey.export.submit |
POST /api/v1/journey.export |
none | ExportID. Then GET /api/v1/journey.export with ExportID and download=true |
Examples:
# journey.stats.byaction
curl -G https://app.emailmarketer.io/api/v1/journey.stats.byaction \
-d APIKey="$EM_API_KEY" \
-d JourneyID=789
# journey.stats.byisp
curl -G https://app.emailmarketer.io/api/v1/journey.stats.byisp \
-d APIKey="$EM_API_KEY" \
-d JourneyID=789
# journey.action.subscribers
curl -G https://app.emailmarketer.io/api/v1/journey.action.subscribers \
-d APIKey="$EM_API_KEY" \
-d JourneyID=789 \
-d ActionID=1 \
-d Filter=opened
# account.journey.benchmark
curl -G https://app.emailmarketer.io/api/v1/account.journey.benchmark \
-d APIKey="$EM_API_KEY"
# journey.export.submit
curl https://app.emailmarketer.io/api/v1/journey.export \
-H "Content-Type: application/json" \
-d '{ "APIKey": "'"$EM_API_KEY"'" }'
# Download the export
curl -G https://app.emailmarketer.io/api/v1/journey.export \
-d APIKey="$EM_API_KEY" \
-d ExportID=321 \
-d download=true