ITiterable
workflows

Trigger a journey (workflow)

Triggers a journey (formerly known as workflow). Triggering with a list is asynchronous. If a list trigger is in progress, it must finish before the same list can be triggered again for a particular journey. The journey stats may take several minutes to update if other journeys are running. If the journey's start tile has a suppression list, that will apply.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

post/api/workflows/triggerWorkflow

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

dataFieldsobject

Additional data associated triggering event

emailstring

An email address that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

listIdinteger

(Optional) Trigger the journey for all users in a list (standard or dynamic)

userIdstring

A user ID that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

workflowIdinteger required

ID of journey (workflow) to trigger

Response

successful operation

code'Success' | 'BadApiKey' | 'BadAuthorizationHeader' | 'BadJsonBody' | 'BadParams' | 'BatchTooLarge' | 'DatabaseError' | 'EmailAlreadyExists' | 'ExternalKeyConflict' | 'Forbidden' | 'ForbiddenParamsError' | 'ForgottenUserError' | 'GenericError' | 'InvalidEmailAddressError' | 'InvalidJwtPayload' | 'InvalidUserIdError' | 'JwtUserIdentifiersMismatched' | 'NotFound' | 'QueueEmailError' | 'RateLimitExceeded' | 'RequestFieldsTypesMismatched' | 'Unauthorized' | 'UniqueFieldsLimitExceeded' | 'UnknownEmailError' | 'UnknownUserIdError' | 'UserIdAlreadyExists' required
msgstring required

Response description

paramsobject

Additional info

Changes

No recorded changes to this operation across all 4 revisions of this API.