Send Review Invite

Send a review invite to a customer through Cloutly.

POST /send-review-invite

Send a review invite by creating a contact in a business campaign.

Request

POST https://app.cloutly.com/api/v1/send-review-invite

{
  "firstName": "John",
  "lastName": "Smith",
  "email": "[email protected]",
  "phoneNumber": "[phone]",
  "source": "api",
  "sourceContactId": "number123",
  "businessId": "44271176-7053-4534-ad6f-b38d132d341e",
  "campaignId": "2c07094a-ed58-4cf2-9595-cf1b1d303d9d",
  "inviteDelayDays": 1
}

Response

{
  "contact": {
    "id": "fbd481f1-719e-4f38-b1ab-49109c65f164",
    "firstName": "john",
    "lastName": "smith",
    "email": "[email protected]",
    "phoneNumber": null,
    "source": "api",
    "sourceContactId": "number123"
  },
  "usage": {
    "smsLimitsLeft": 19,
    "renews": "2023-07-28T16:40:27.243Z"
  }
}

Notes

• Provide at least one contact channel: email or phoneNumber.

• Use businessId from GET /businesses.

• campaignId is optional and uses the business default campaign when omitted.

• inviteDelayDays can be omitted for immediate send.

• source and sourceContactId are optional tracking metadata.

Alternate request shape

Use this request shape when integrating through the marketplace business path:

POST https://marketplace.cloutly.com/api/v2/businesses/{businessId}/send-review-invite

{
  "sourceContactId": "id321",
  "campaignId": "id123",
  "firstName": "John",
  "lastName": "Smith",
  "channel": {
    "email": "[e-mail]",
    "phoneNumber": "4412321321321"
  },
  "source": "my-platform",
  "inviteDelayHours": 24,
  "products": [
    {
      "sourceProductId": "12345", // Your source Product ID
      "title": "Peroni",
      "description": "A refreshing cold beer.",
      "imageUrl": "https://example.com/beer.png"
    }
  ]
}