Enroll contact in a sequence using Sequences API in HubSpot

Develop, Build & Integrate APIs & Integrations
1

Hello! I have a custom coded workflow action where I’m trying to enroll contacts into a sequence using the Sequences API, but I keep running into errors.

I’ve created a Private App in HubSpot with read/write access to Contacts and Sequences.

Here’s my code:

exports.main = async (event, callback) => {
const contactId = event.object.hs_object_id || event.object.objectId;

console.log('Contact ID:', contactId);

const hubspotAccessToken = process.env.AE_HUBSPOT_ACCESS_TOKEN;
const senderEmail = "insert email address";
const userId = 'insert user id';
const sequenceId = 'insert sequence id';

const enrollmentData = {
contactId: contactId,
senderEmail: senderEmail,
sequenceId: sequenceId,
};

const requestUrl = `https://api.hubapi.com/automation/v4/sequences/enrollments?userId=${userId}`;

console.log('Request URL:', requestUrl);
console.log('Request Body:', JSON.stringify(enrollmentData));

try {
const response = await fetch(requestUrl, {
method: 'POST',
headers: {
'Authorization': `Bearer ${hubspotAccessToken}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(enrollmentData),
});

if (!response.ok) {
const errorBody = await response.text();
console.error('Error response body:', errorBody);
throw new Error(`HTTP error! Status: ${response.status}, Message: ${errorBody}`);
}

const responseData = await response.json();
console.log('Contact enrolled successfully:', responseData);

callback({
outputFields: {
enrollmentStatus: 'Success',
enrolledEmail: senderEmail,
},
});
} catch (error) {
console.error('Error enrolling contact:', error.message);
callback({
outputFields: {
enrollmentStatus: 'Failure',
errorMessage: error.message,
},
});
}
};

I’ve confirmed the user ID and sequence ID are correct. The sequence is active and accessible to all. The contacts I’m using to test have not already been enrolled in the sequence. The user I’m setting the user ID for has all the correct permissions.

Here’s the error I keep getting:

HTTP error! Status: 500, Message: {“status”:“error”,“message”:“Exception in external client”,“errorType”:“SequenceError.EXTERNAL_CLIENT_EXCEPTION”,“correlationId”:“7d7702fa-ccf0-4f20-ad7a-943f575a3ddc”}
Any ideas would be appreciated!
2

Hey, @BDoran8 :waving_hand: Can you link me to the documentation you used to find this endpoint? I checked here — Automation v4 API (BETA), but didn’t find anything Sequence-related.

Thanks! — Jaycee

3
4

@Jaycee_Lewis what’s weird is when I go to the link you sent, I see Sequences (Beta) in the sidebar, but when I click on it, it just brings me back to the Create & Manage Workflows page. Maybe it’s not actually live in Beta yet?!

5

That is strange. I get the same result. I’ll reach out to the tech writers for the dev docs and see if I can get us some clarity. — Jaycee

6

Here is the link to the sequences beta docs: Accounts Dashboard | HubSpot
Can we please get some help with this? It is very frustrating that it seems this endpoint is blocked for using external tools like Postman.

7

@BDoran8 I just solved my issue with this. The problem for me was that I was using the wrong user id. There is the UserID found in the URL when you are looking at users in settings, and then there is the UserID that is used for “ownership” (contacts, deals, etc.). I am used to using the latter, but once I used the one in the url for the user management, it worked!

8

Finally had a chance to try this out, and it worked!! Thanks @BEAutoBot !

9

Just to add some specifics. @BEAutoBot is referring to the id parameter that you can pull from the Owners API via “/crm/v3/owners” (not the userId). You can also pull that information via the Users API if you specify you want to return the hubspot_owner_id via the properties field when you retrieve users (via whichever API path: users, users/batch/read, or users/search).

Those paths have the user IDs that can be used with the Sequences API

*Another caveat I’m learning. If you’re using a private app to access the API, you have to use the ID of the same user that created / owns that private app. I’m not 100% on this part, but it seems to be my experience.

10

Just incase it’s helpful for anyone, we’ve launched an app called Enrollem, which adds a custom workflow action allowing you to enroll contacts in a sequence without the need for using a custom WF action or without needing an Enterprise plan.

You can check it out here

11

Just wanted to share another option, we built FlowNer, which handles this exact use case. It lets you enroll and unenroll contacts into/from sequences directly from workflows, without the Sequences API or custom code.

Won’t fix the underlying API issue, but if you’d rather not do custom code, it might be worth to take a look