There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Enroll a contact into a workflow

Last updated May 15, 2023

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

Note: The Workflows API currently only supports contact-based workflows.

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 private app access token Authorization: Bearer {token} header 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.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example POST URL: https://api.hubapi.com/automation/v2/workflows/10900/enrollments/contacts/testingapis@hubspot.com Returns a 204 No content response on success Returns a 404 error if the workflow ID or contact email does not exist in HubSpot. Returns a 412 Precondition Failed error if there is a problem adding the contact to the workflow. See the body of the response for details about the problem.