Remove an existing contact from a list

curl --request POST \
  --url https://api.hubapi.com/contacts/v1/lists/{list_id}/remove \
  --header 'Content-Type: application/json' \
  --data '
{
  "vids": [
    123
  ],
  "emails": [
    "<string>"
  ]
}
'

{
  "updated": [
    123
  ],
  "discarded": [
    123
  ],
  "invalidVids": [
    123
  ],
  "invalidEmails": [
    "<string>"
  ]
}

POST

contacts

lists

{list_id}

remove

Remove an existing contact from a list

curl --request POST \
  --url https://api.hubapi.com/contacts/v1/lists/{list_id}/remove \
  --header 'Content-Type: application/json' \
  --data '
{
  "vids": [
    123
  ],
  "emails": [
    "<string>"
  ]
}
'

{
  "updated": [
    123
  ],
  "discarded": [
    123
  ],
  "invalidVids": [
    123
  ],
  "invalidEmails": [
    "<string>"
  ]
}

Path Parameters

list_id

integer

required

The list ID for the list you're removing the contact from.

Body

application/json

vids

integer[]

The contact IDs of the contacts that you're removing from the list.

emails

string[]

The email addresses of the contacts that you're removing from the list.

Response

200 - application/json

Successful response with removal results

updated

integer[]

discarded

integer[]

invalidVids

integer[]

invalidEmails

string[]

⌘I