API Reference
Testimonial
Create a Testimonial defined by testimonial.
POST
AUTHENTICATION
Authorization
Bearer
Bearer
BODY PARAMETERS
body
TestimonialInput
brandId
string
Example: 9d885046-f7bf-401e-8f02-83e261553f5b
The brand if for a registered website / brand (use GET of Websites API endpoint first)
firstname
string
Example: Adrian
First name of testimonial giver
lastname
string
Example: Dray
Last name of testimonial giver
title
string
Example: Adrian Dray
Title of testimonial
subtitle
string
Example: GDPR Expert, Adrian Dray Consulting
Subtitle of testimonial
company
string
Example: Adrian Dray Consulting
Company of testimonial giver
email
string
Example: adrian@email.com
Email address of testimonial giver
imageUrl
string
Example: https://dealmaker.blob.core.windows.net/images/t_0a9ab71cd20f4bf1b11130e71479743d/silhouette_male.png
URL to image
testimonialText
string
Example: Always fantastic support. I love that Trust keep bringing out brilliant features on a recent basis that makes me and my clients go 'Wow'
Text of the testimonial
externalVideoHtml
string
HTML of embeddable video (Youtube, Facebook, vimeo, ...
videoToken
string
Example: r1ac3a4cfe79f3896fce25bffbe16dd3
Token of uploaded video. Required when using an uploaded video along with 'VideoUrl'
videoUrl
string
Example: https://video-cdn-eu-west-1.ziggeo.com/v1/applications/r1ac3a4cfe79f3896fce25bffbe16dd3/videos/r127c94ce5906ee6f636f6a582d77194/video.mp4
URL of uploaded video. Required when using an uploaded video along with 'VideoToken'
socialMediaProfiles
string[]
Example: https://www.facebook.com/trusttestimonials,https://www.linkedin.com/company/trust-platform
Array of string of social media profile URLs
stars
number<float>
Example: 5
Amount of given stars
gaveConsent
boolean
Example: true
Did testimonial giver gave consent to publish it?
consentDateTime
string<date-time>
Date and time when testimonial giver gave consent to publish it
published
boolean
Example: true
Is testimonial published to show via any widget?
RESPONSES
201
Returns created testimonial.
TestimonialApiDb
Example: [object Object]
id
string<uuid>
typeId
string<uuid>
created
string<date-time>
firstname
string
lastname
string
title
string
subtitle
string
company
string
email
string
imageUrl
string
testimonialText
string
contractUrl
string
contractStatus
string
contractSigned
boolean
externalVideoHtml
string
videoToken
string
videoUrl
string
socialMediaProfiles
string[]
Example:
stars
number<float>
gaveConsent
boolean
consentDateTime
string<date-time>
published
boolean
400
Bad Request
string
500
Server Error
string
Updated 03 Mar 2023
Did this page help you?