post
https://partner.gupshup.io/partner/app//bizai/agent_config/faq
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request parameters
| Parameter | Type | Required | In | Description |
|---|---|---|---|---|
Authorization | string | Yes | Header | Partner app token, sent raw. Bearer <token> is also accepted. |
Content-Type | string | Yes | Header | application/json |
appId | string (uuid) | Yes | Path | Partner Portal app id. Stands in for Meta's entity_id. |
question | string | Yes | Body | FAQ question. Must be unique per app; a duplicate returns 409. |
answer | string | Yes | Body | FAQ answer. |
metadata | object | No | Body | Optional. Every value must be a string; a number is rejected. |
metadata.{key} | string | No | Body | One entry per name. |
Example request
curl --location --request POST 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_config/faq' \
--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 — 201
201| Parameter | Type | Description |
|---|---|---|
id | string | Resource id. Meta pfbid… id. |
question | string | FAQ question. Must be unique per app; a duplicate returns 409. |
answer | string | FAQ answer. |
created_at | integer | Unix seconds. |
metadata | object | Documented by Meta, but not echoed back by the wrapper. |
metadata.{key} | string | One entry per name. |
Example response — 201 Created
201 Created{
"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"
} 429Per-app rate limit exceeded. Retry after the 60-second window.
500Known defect: empty-string question/answer pass the required check and fail downstream
with a bare-text Internal Server Error instead of a 400.
