Update skill

Send only the fields being changed.

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.
skillIdstringYesPathSkill id (pfbid). Meta pfbid… id.
titlestringNoBodyPattern ^[a-z0-9]+(-[a-z0-9]+)*$. Max 64 chars.
descriptionstringNoBodyMax 1024 chars.
skillstringNoBodyMax 20000 chars.

Example request

curl --location --request PUT 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_config/skills/<skillId>' \
  --header 'Authorization: <PARTNER_APP_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Apply when customer initiates conversation"
}'

Response parameters — 200

ParameterTypeDescription
titlestringPattern ^[a-z0-9]+(-[a-z0-9]+)*$. Max 64 chars.
descriptionstringMax 1024 chars.
skillstringMax 20000 chars.
idstringResource id. Meta pfbid… id.
channelstringChannel the record belongs to, e.g. whatsapp.
created_atintegerCreation time, Unix seconds.
metadataobjectFree-form key/value data attached to the record.
statusstringA skill read straight after a write is normally pending_review. One of: active, pending_review, blocked.

Example response — 200 OK

{
  "id": "pfbid0SkillExampleId",
  "title": "greeting-skill",
  "description": "Apply when customer initiates conversation",
  "skill": "Respond warmly and professionally. Ask how you can help.",
  "channel": "whatsapp",
  "created_at": 1789630852,
  "status": "pending_review"
}

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

Skill id (pfbid).

Body Params
string
length ≤ 64
^[a-z0-9]+(-[a-z0-9]+)*$
string
length ≤ 1024
string
length ≤ 20000
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