Customers

On this page, we'll dive into the different customer endpoints you can use to manage customers programmatically. We'll look at how to query, create, update, and delete customers.

POST/api/v1/request-reviews/customers

Create a customer

This endpoint allows you to add a new customer to a customer list in EmbedMyReviews. To add a customer, you must provide their email and/or phone number.

Required permissions

View, create, edit and delete request

Required attributes

  • Name
    list_id
    Type
    string
    Description

    The customer list id - can be found by going to the customer list and then click on the settings tab.

  • Name
    email
    Type
    string
    Description

    The email for the customer. Required if phone is not provided.

  • Name
    phone
    Type
    string
    Description

    The phone number for the customer. Required if email is not provided.

  • Name
    phone_country
    Type
    string
    Description

    The phone country for the customer. Required if phone number is provided.

Optional attributes

  • Name
    first_name
    Type
    string
    Description

    The first name for the customer.

  • Name
    last_name
    Type
    string
    Description

    The last name for the customer.

Request

POST
/api/v1/request-reviews/customers
curl https://your-whitelabel-domain.com/api/v1/request-reviews/customers \
  -H "Authorization: Bearer {token}" \
  -d list_id="c30f0216-8688-4802-a1fd-5e138cbdafc2" \
  -d email="[email protected]" \
  -d phone="1-800-759-3000" \
  -d phone_country="US" \
  -d first_name="Bob"

Response

{
  "id": "1a88e2e3-181b-4164-8054-8a532e9eb9cb",
  "message": "Customer added successfully",
}