Enroll a contact into a workflow

POST /automation/v2/workflows/:workflowId/enrollments/contacts/:email

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Add a contact to a workflow.

You will want to use this in the event that a contact meets a set of criteria that makes enrolling them in a workflow relevant to them, for example downloading a whitepaper and then getting enrolled in a workflow that sends emails based on the content of that whitepaper.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Workflow ID Used in the request URL The ID of the workflow you wish to see metadata for.
Email Address Used in the request URL The email of the contact you wish to enroll in the workflow.
Optional Parameters How to use Description
None None No optional parameters for this method.

If the request succeeds, you'll get an HTTP 204 response.