# Send Review Invite

## POST /send-review-invite

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

### Request

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

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

### Response

```json
{
  "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:

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

{
  "sourceContactId": "id321",
  "campaignId": "id123",
  "firstName": "John",
  "lastName": "Smith",
  "channel": {
    "email": "useremail@gmail.com",
    "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"
    }
  ]
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cloutly.com/reviews-sdk-for-marketplace-websites/rest-api/invite-customer.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
