Remove an existing contact from a list

POST /contacts/v1/lists/:list_id/remove

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Remove a contact record that has already been created in the system from a contact list.

Please note that you cannot manually remove contacts to dynamic lists - they can only be updated by the contacts system based on the properties of the list itself. To determine whether a list is dynamic or static, when you get a list, you will see a flag called dynamic that equates to true or false.

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.
List ID Used in the request URL The list ID for the list you're removing the contact from. You can search for lists using the get lists method.
Contact ID Used in the request body The contact ID of the contact that you're removing from the list.
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL to POST to:  https://api.hubapi.com/contacts/v1/lists/2/remove?hapikey=demo

Returns a 404 error if there is no list with the specified ID.

Returns a 400 error if there is a problem removing the records from the list. The response JSON will include a message field with more details. You will receive a 400 error when trying to remove contacts from a dynamic list.