Skip to main content
POST
/
review_booster
/
send_invitation
curl --request POST \
  --url https://api.partoo.co/v2/review_booster/send_invitation \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '{
  "business_id": "5409c35a97bbc544d8e26737",
  "target_phone": "+33647385968",
  "target_name": "John Doe",
  "template_id": 31
}'
{
  "invitation_id": "d3d8c966-0356-4ec0-baae-13ec3622ebc2",
  "status": "success"
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Body

application/json
​
business_id
string
required

Business id

Example:

"5409c35a97bbc544d8e26737"

​
target_phone
string
required

Customer phone number, with the country calling code. Eg: +33601020304

​
target_name
string

Customer fullname

Maximum length: 255
​
template_id
integer
deprecated

Id of the SMS template you want to use

​
invite_content
string

To customize SMS content instead of using the SMS template associated with the user. Cannot be used in combination with template_id. @link must be included in your payload (corresponds to the dynamic link that will allow the SMS recipient to leave a review on the business). Max 286 characters (unicode characters are not accepted - will be removed)

​
force
enum<string>
default:False

To force invitation sending when a SMS has already been sent to the customer

Available options:
True,
False

Response

OK

​
invitation_id
string

invitation id

Example:

"d3d8c966-0356-4ec0-baae-13ec3622ebc2"

​
status
enum<string>

Request status

Available options:
success