Save testimonials

Overview

Set the business's testimonials.

Use this to add or edit them.

You'll need the testimonials.

They're saved. Each save replaces all of the account's testimonials, so send the full list (at least one).

Prerequisites

A bearer token. See Authentication.
The account's id (company_id).

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/account/faq/testimonials

Authentication

Partner or Account token

company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
An account outside your tree, or one that doesn't exist, is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Description
`company_id`	integer	Yes	The account. Must exist and be inside your account tree.
`testimonials`	array of objects	Yes	The full list of testimonials, at least one. Replaces the saved list.
`testimonials[].content`	string	Yes	The testimonial, as HTML.

Request payload

{
  "company_id": 5994,
  "testimonials": [
    {
      "content": "<p>Great service, highly recommend!</p>"
    },
    {
      "content": "<p>The team was fantastic.</p>"
    }
  ]
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`message`	string	`Testimonials saved successfully`.

Response payload

{
  "data": {
    "status": "success",
    "message": "Testimonials saved successfully"
  }
}

Examples

Success payload

See Response payload.

Error payload

422 testimonials is missing or empty

{
  "message": "The testimonials field is required.",
  "errors": {
    "testimonials": [
      "The testimonials field is required."
    ]
  }
}

422 A testimonial has no content

{
  "message": "The testimonials.0.content field is required.",
  "errors": {
    "testimonials.0.content": [
      "The testimonials.0.content field is required."
    ]
  }
}

422 Account outside your tree

{
  "message": "The selected company id does not belong to your company hierarchy.",
  "errors": {
    "company_id": [
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

Status	Meaning
`200`	The testimonials were saved.
`401`	The token is missing, expired or invalid.
`422`	`testimonials` is missing or empty, an entry has no `content`, or `company_id` is missing, doesn't exist or is outside your tree.
`500`	Unexpected server error.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/faq/testimonials" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994, "testimonials": [{"content": "<p>Great service, highly recommend!</p>"}, {"content": "<p>The team was fantastic.</p>"}]}'

Updated 17 days ago

Did this page help you?