Add Runner

Initializes a new campaign workflow runner context. The context can be initialized using either a set of contactIds or a series of statements. The two fields are mutually exclusive. Documentation on how to use statements can be found in the Search Contacts section.

Request body variables:

• displayName: Display name in the UI for this runner.
• contactIds: List of contactIds that will be started in the workflow.
• statements: List of statements that identify the contacts that will be started in the workflow. All contacts that match the query will be added.
• start: If set to true, this will start the workflow. If not set or false it will not start the workflow and leave it in a non-started state. If periodMs is 0 the workflow will also not be started regardless of what this is set to.
• periodMs: Delay between sends. If not set it will default to 0. Campaigns with this set to 0 cannot be started without setting this to a non-zero value, however they can be manually "clicked" through by using the batch/next endpoint detailed below.