Update FAQ

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request parameters

ParameterTypeRequiredInDescription
AuthorizationstringYesHeaderPartner app token, sent raw. Bearer <token> is also accepted.
Content-TypestringYesHeaderapplication/json
appIdstring (uuid)YesPathPartner Portal app id. Stands in for Meta's entity_id.
faqIdstringYesPathFAQ id (pfbid). Meta pfbid… id.
questionstringYesBodyFAQ question. Must be unique per app; a duplicate returns 409.
answerstringYesBodyFAQ answer.
metadataobjectNoBodyOptional. Every value must be a string; a number is rejected.
metadata.{key}stringNoBodyOne entry per name.

Example request

curl --location --request PUT 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_config/faq/<faqId>' \
  --header 'Authorization: <PARTNER_APP_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "question": "What is your return policy?",
  "answer": "We accept returns within 30 days of purchase with original receipt.",
  "metadata": {
    "category": "returns",
    "priority": "high"
  }
}'

Response parameters — 200

ParameterTypeDescription
idstringResource id. Meta pfbid… id.
questionstringFAQ question. Must be unique per app; a duplicate returns 409.
answerstringFAQ answer.
created_atintegerUnix seconds.
metadataobjectDocumented by Meta, but not echoed back by the wrapper.
metadata.{key}stringOne entry per name.

Example response — 200 OK

{
  "id": "pfbid0GNkFaqExampleId",
  "question": "What is your return policy?",
  "answer": "We accept returns within 30 days of purchase with original receipt.",
  "created_at": 1789630852
}

Error responses

400 Bad Request — The app is not live, or WASS does not consider it live.

{
  "message": "App is not live.",
  "status": "error"
}

400 Bad Request — The app has no phone number attached. Checked before the live check.

{
  "message": "Phone id not found for the given App",
  "status": "error"
}

401 Unauthorized — Authorization is missing or invalid, belongs to another app, or appId is unknown or not a UUID.

{
  "status": "error",
  "message": "Unauthorised access to the resource. Please review request parameters and headers and retry"
}

405 Method Not Allowed — Any method other than GET, POST, PUT or DELETE, e.g. PATCH.

{
  "status": "error",
  "message": "Request method 'PATCH' is not supported"
}

429 Too Many Requests — More than 30 /bizai/** requests in 60 seconds for this app. The 31st is rejected.

{
  "status": "error",
  "message": "Too Many Requests"
}
Path Params
uuid
required

Partner Portal app id. Stands in for Meta's entity_id.

string
required
^pfbid

FAQ id (pfbid).

Body Params
string
required
length ≥ 1
string
required
length ≥ 1
metadata
object

Optional. Every value must be a string; a number is rejected.

Responses

429

Per-app rate limit exceeded. Retry after the 60-second window.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json