v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Remove contacts from List

Remove specific contacts from an existing List.

post/core/v3/stores/{store_id}/lists/{list_id}/remove-contacts

Path parameters

store_idstring required

The store ID (app_key)

list_idstring required

The ID of the List from which the customer will be removed

Request body

emailstring

The email of the contact you want to remove from the list

phone_numberstring

The phone number of the contact you want to remove from the list

Response

200

Example response

{
  "data": {
    "action": "list_contact_remove",
    "success": true,
    "result": "success",
    "list": {
      "id": "4001234",
      "name": "Default Marketing List",
      "created": "2022-09-01T15:43:55",
      "last_updated": "2023-12-27T15:28:14",
      "total_contacts": 3800
    },
    "contact_results": [
      {
        "contact": {
          "email": "example@yotpo.com"
        },
        "result": "removal_request_received"
      }
    ]
  }
}