Create a review campaign

POST

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

This API creates a review campaign to request customer reviews for a specific location.

Behavior:

Sends review requests to customers via supported channels (e.g., email, SMS).

Allows customization of campaign message and branding.

Supports targeting options, such as specific customer segments.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "locationId": "TG9jYXRpb246MTQwMjQ=",
        "name": "Christmas Sale Feedback",
        "locationCustomers": [
            {
                "name": "John",
                "email": "xyz@gmail.com",
                "phone": "3863443131"
            }
        ],
        "screening": true,
        "landingPageTemplate": {
            "content": "Please take a moment to review your experience with us on one of these review sites.",
            "heading": "Thank you. We are glad to hear that you had a great experience with us.",
            "reviewSiteHash": [
                {
                    "name": "Google",
                    "url": "maps.google.com"
                },
                {
                    "name": "Yelp",
                    "url": "www.yelp.com/biz"
                }
            ]
        },
        "openingEmailTemplate": {
            "replyTo": "user@domain.com",
            "subject": "Tell us how we did",
            "heading": "ASD is committed to providing the best experience and service possible!",
            "content": "Please take 5 minutes to share some feedback on your experience!"
        },
        "smsTemplate": {
            "content": "Hi, Thank you for visiting ASD. Can you take a few seconds to review your experience with us? {{short_url}}"
        }
    }
}

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' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "locationId": "TG9jYXRpb246MTQwMjQ=",
        "name": "Christmas Sale Feedback",
        "locationCustomers": [
            {
                "name": "John",
                "email": "xyz@gmail.com",
                "phone": "3863443131"
            }
        ],
        "screening": true,
        "landingPageTemplate": {
            "content": "Please take a moment to review your experience with us on one of these review sites.",
            "heading": "Thank you. We are glad to hear that you had a great experience with us.",
            "reviewSiteHash": [
                {
                    "name": "Google",
                    "url": "maps.google.com"
                },
                {
                    "name": "Yelp",
                    "url": "www.yelp.com/biz"
                }
            ]
        },
        "openingEmailTemplate": {
            "replyTo": "user@domain.com",
            "subject": "Tell us how we did",
            "heading": "ASD is committed to providing the best experience and service possible!",
            "content": "Please take 5 minutes to share some feedback on your experience!"
        },
        "smsTemplate": {
            "content": "Hi, Thank you for visiting ASD. Can you take a few seconds to review your experience with us? {{short_url}}"
        }
    }
}'

Responses

🟢200OK

application/json

Successfully created review campaign

Body

Example

{}

🟠403Forbidden

Modified at 2025-07-23 08:16:25

Review Campaign Info Attributes

Add customers to a review campaign