POSTapi.synup.com/api/v4/locations/review-campaigns/customers

Add customers to a review campaign

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.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Body

Name	Type	Required
`input`	object	required
`input.reviewCampaignId`	string	required
`input.locationCustomers`	array of object	required
`input.locationCustomers[].name`	string	required
`input.locationCustomers[].email`	string	optional
`input.locationCustomers[].phone`	string	optional

Request

curl -X POST 'https://api.synup.com/api/v4/locations/review-campaigns/customers' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '""'

const res = await fetch('https://api.synup.com/api/v4/locations/review-campaigns/customers', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(""),
});
const data = await res.json();

import requests
res = requests.post(
    "https://api.synup.com/api/v4/locations/review-campaigns/customers",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json="",
)
data = res.json()

req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/review-campaigns/customers", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successfully added customers

Example response (generated from the schema)

{}