Save FAQs

Overview

Set the business's frequently asked questions.

Use this to add or edit them.

You'll need the questions and answers.

The list is saved. Each save replaces all of the account's FAQs of that type (or those with no type, when you leave type out), so send the full list. faqs must have at least one entry.

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/save

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.
`type`	string	No	Which page the FAQs are for: `landing_page` or `widget`. Left out: saved with no type.
`faqs`	array of objects	Yes	The full list of FAQs, at least one. Replaces the saved list.
`faqs[].question`	string	Yes	The question.
`faqs[].answer`	string	Yes	The answer.
`faqs[].status`	string	Yes	`active` or `inactive`.

Request payload

{
  "company_id": 5994,
  "type": "landing_page",
  "faqs": [
    {
      "question": "How do I leave a review?",
      "answer": "Click the link in the email we sent you.",
      "status": "active"
    },
    {
      "question": "Can I edit my review?",
      "answer": "Contact support to make changes.",
      "status": "inactive"
    }
  ]
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	array of objects	The `faqs` you sent, as sent.
`data[].question`	string	The question.
`data[].answer`	string	The answer.
`data[].status`	string	`active` or `inactive`.
`message`	string	`FAQ saved successfully`.

Response payload

{
  "data": {
    "status": "success",
    "data": [
      {
        "question": "How do I leave a review?",
        "answer": "Click the link in the email we sent you.",
        "status": "active"
      },
      {
        "question": "Can I edit my review?",
        "answer": "Contact support to make changes.",
        "status": "inactive"
      }
    ],
    "message": "FAQ saved successfully"
  }
}

Examples

Success payload

See Response payload.

Error payload

422 faqs is missing or empty

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

422 A status isn't allowed

{
  "message": "The selected faqs.0.status is invalid.",
  "errors": {
    "faqs.0.status": [
      "The selected faqs.0.status is invalid."
    ]
  }
}

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 FAQs were saved.
`401`	The token is missing, expired or invalid.
`422`	`faqs` is missing or empty, an entry is missing a field or has a status that isn't allowed, 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/save" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994, "type": "landing_page", "faqs": [{"question": "How do I leave a review?", "answer": "Click the link in the email we sent you.", "status": "active"}, {"question": "Can I edit my review?", "answer": "Contact support to make changes.", "status": "inactive"}]}'

Updated 17 days ago

Did this page help you?