Request a Testimonial

You can send a testimonial request email by calling the Post request to the

https://app.socialprf.io/api/1.1/wf/request_testimonial endpoint.

It will automatically send an email that will contain your invitation link so that your users can go submit their testimonials, like the following:

The mandatory fields for making this API request are

FieldTypeDefinition

api_key

Mandatory

The API key of your organisation.

request_from_name

mandatory

The name of the user from whom you are requesting a testimonial

request_from_email

optional

The email of the user from whom testimonial is requested. Leave empty if you want to send request by SMS or if you want to send email by yourself by getting the invitation URL

request_from_phone

optional

The phone number of the user from whom testimonial is requested. Leave empty if you want to send request by email. Please note: The phone number should include the international code. For example: +447459451xxx

request_from_role

optional

The role or designation of the user that you want to display in your widgets.

request_title

optional

If you want to change the default title of the request landing page, pass the new title in this parameter

request_message

optional

The personalised message that you want to send to your user. Leave this empty if you want to send the default message to the user.

request_video_url

optional

If you want to change the default video on the landing page, pass the URL of the video in this parameter. Pass the full URL of the video in this parameter. If you are passing URL of youtube hosted video, then the URL has to be of the format https://youtu.be/_qN1QYVbffg

request_type

Mandatory

The type of request you are sending to the user. This can take only the below two values. * Video/ Text Testimonial * Capture Reviews in 3rd Party Sites

requestor_name

optional

The name of the user or org requesting the testimonial

remind_seven_day

Mandatory

Specify if you want to automatically send a reminder email on the 7th day again. Possible values are * yes * no

remind_thirty_day

Mandatory

Specify if you want to automatically send a reminder email on the 30th day again. Possible values are * yes * no

metadata

optional

Use this parameter to pass any custom values along with the request, for example - product name.

Response Example
{ 
"status": "success", 
"response": 
    { 
        "invitation_url": "https://app.socialprf.io/video_txt?recordId=rech6EVcCtdoVCxL3&primeId=recBUKxQ0YMikh9jV&n=Bangu&o=CEO&e=bangu.kutty@gmail.com" 
    } 
}

Last updated