v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Add contacts to List

Add specific contacts to an existing List.

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

Path parameters

store_idstring required

The store ID (app_key)

list_idstring required

The ID of the list to which the customers will be added

Request body

emailstring

The email address of the contact you want to add to the list

phone_numberstring

The phone number of the contact you want to add to the list

Response

200

Example response

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