addContactsToWorkflow

Overview

The addContactsToWorkflow function allows you to add contacts to a workflow that contains the Received API Event trigger. NOTE: You can only add contacts to workflows which contain the Received API Event trigger.

Syntax

writeResult = bApi.addContactsToWorkflow(workflowObject[] workflow,
 contactObject[] contacts);

Required and Optional Workflow Object Attributes

Name Type Required Description
id string Yes if no workflow name is specified The unique id assigned to the workflow. You can obtain the id for a workflow by calling readWorkflow. The Received API Event trigger needs a workflow ID in order to trigger (start) the workflow.

Required and Optional Contact Object Attributes

Name Type Required Description
id string Yes if no email address is specified The unique id for the contact. The id can be used to reference a specific contact when using the contact functions. You can obtain the id for a contact by calling readContacts, or by looking at the footer when viewing the overview page for an individual contact in the application.
email string Yes if no contact id is specified The email address assigned to the contact. The email address can be used to reference a specific contact when using the contact functions.