Add customers to a review campaign

POST

https://api.synup.com/api/v4/locations/review-campaigns/customers

This API adds new customers to an existing review campaign, allowing them to receive review requests.

Behavior:

Supports batch addition of multiple customers in a single request.

Customers will receive review requests via the configured delivery method (email, SMS, or both).

Ensures duplicate entries are not added to the same campaign.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "reviewCampaignId": "string",
        "locationCustomers": [
            {
                "name": "string",
                "email": "user@example.com",
                "phone": "string"
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synup.com/api/v4/locations/review-campaigns/customers' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "reviewCampaignId": "string",
        "locationCustomers": [
            {
                "name": "string",
                "email": "user@example.com",
                "phone": "string"
            }
        ]
    }
}'

Responses

🟢200OK

application/json

Successfully added customers

Body

Example

{}

Modified at 2025-05-15 13:50:45

Create a review campaign

List review campaigns