There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Unenroll a contact from a workflow

Last updated May 31, 2023

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

Method Details

HTTP Methods:

DELETE

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Remove a contact from a workflow.

If a contact is removed from a workflow, all future events that they are scheduled for will not take place. One application of this endpoint could be removing a contact from a marketing automation workflow if they are closed as a customer in your CRM.

 

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 unenroll from the workflow.
Optional Parameters How to use Description
None None No optional parameters for this method.