Skip to main content

API - Submit a text testimonial

Submit a text testimonial with POST /v1/submit/text and your Space API key. Optionally add it to the Wall of Love.

Written by Damon Chen

Submit a text testimonial with a POST request to https://api.testimonial.to/v1/submit/text. Send your Space API key in the Authorization: Bearer API_KEY header. You can also add the testimonial to your Wall of Love in the same request.


Make a request

Replace API_KEY with your Space API key. Replace the example name and email with the submitter’s details.

curl --location --request POST 'https://api.testimonial.to/v1/submit/text' \
--header 'Authorization: Bearer API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"testimonial": "text testimonial test",
"rating": 5,
"name": "Jordan Hale",
"title": "Founder of Brightline",
"email": "[email protected]",
"socialLink": "https://twitter.com/example",
"avatarURL": "https://example.com/avatar.jpg",
"attachedImageURL": "https://example.com/photo.jpg",
"confirm": true,
"isLiked": true
}'


Parameters

Two parameters are required:

  1. testimonial — the content of the testimonial

  2. name — the submitter’s name

Optional parameters:

  1. rating — a 1–5 rating

  2. attachedImageURL — URL of the attached image

  3. email — the submitter’s email

  4. avatarURL — the submitter’s avatar URL

  5. title — the submitter’s title and company

  6. socialLink — the submitter’s social profile link (for example, a LinkedIn URL)

  7. confirm — whether the submitter permits public use of the testimonial. false by default

  8. isLiked — add the testimonial to the Wall of Love. false by default


Get your API key

Open the dashboard. On the Space card, click the 3-dot icon and choose API key.

In the popup, click Copy API Key.


Return value

A successful request returns status success and message The text testimonial is uploaded successfully.

A failed request returns status failed and a message that explains why.

{
"status": "failed",
"message": "Rating has to be an integer whose value is between 1 and 5."
}


Need help? Message us in the chat widget.

Did this answer your question?