topic Contact List Opt-out form on website in APIs & Integrations

Contact List Opt-out form on website

eibach-cv — Wed, 20 Dec 2023 23:09:23 GMT

Hello,

Can anybody help me figure out how I can add an opt-out form on a website the uses the Hubspot API to remove contacts from a list?

I have the contact's email and the ILS List ID, am I able to do it with just those two pieces of data?

Or do I have to use the email to get the record ID? If so, how do I do that?

Re: Contact List Opt-out form on website

Jaycee_Lewis — Thu, 21 Dec 2023 18:23:47 GMT

Hey, @eibach-cv I hope you are getting ready to rest up soon before the start of 2024 ✨

This will be an “it depends” kind of answer.

Are you working with an Active or Static List? For an Active List, contacts are automatically added or removed based on set criteria, and manual adjustments aren't possible through the API. If your list is Static, then you can add or remove contacts manually.

For a Static List, you'll need the contact's email to find their contact record ID. Here's how you can do it:

Use the endpoint — Get a contact by email address
Grab the ID from the response
Use the endpoint — Remove an existing contact from a list

If it's an Active (Dynamic) list, you could look at adding a hidden property to your opt-out form. And include the `true` value for this property in your Active List to include or exclude contacts.

For this use case, I don't have an all-in-one solution. It will either require multiple calls or some form of using properties or workflows to update a value that includes or excludes a contact from your list(s).

I hope this helps get you moving forward! — Jaycee

Re: Contact List Opt-out form on website

eibach-cv — Thu, 21 Dec 2023 20:36:36 GMT

Thank you @Jaycee_Lewis !

It is a static list. Are the Get a contact by email address and Remove an existing contact from a list endpoints you referenced from the CRM API? I did a google search for them and the legacy docs are the only thing that come up.

Re: Contact List Opt-out form on website

Jaycee_Lewis — Thu, 21 Dec 2023 21:29:19 GMT

Oh, goodness. I failed to add those links. Yes, that's correct for both endpoints. There's a beta for the new Lists API, but it may not be suitable because of its beta status.

Here are the links for both and to the beta:

The legacy endpoints are stable and supported unless explicitly flagged as to be depreciated or depreciated.

My suggestion is to subscribe to the HubSpot Developer Changelog as it is the primary source for updates, betas, or breaking changes.

Have fun building! — Jaycee