WhatsApp · Business Agent

Create a UI skill

Creates a UI skill.

POSThttps://api.pozy.ai/v1/accounts/{accountId}/business-agent/ui-skills
createBusinessAgentUiSkill

Guide: Business AI agent

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring

Request body

application/json, required

  • titlestring
  • component_typestringrequired

    One of carousel_quick_reply, carousel_url, cta_url, flow, image, interactive_list, interactive_reply_buttons, location, location_request.

  • statusstringrequired

    One of enabled, disabled.

  • instructionstringrequired
  • flow_idinteger

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/ui-skills" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "component_type": "carousel_quick_reply",
  "status": "enabled",
  "instruction": "string"
}'

Response

201 on success

  • titlestring
  • component_typestringrequired

    One of carousel_quick_reply, carousel_url, cta_url, flow, image, interactive_list, interactive_reply_buttons, location, location_request.

  • statusstringrequired

    One of enabled, disabled.

  • instructionstringrequired
  • flow_idinteger
  • idstringrequired
  • created_atinteger
  • updated_atinteger
201 response
{
  "title": "Launch day",
  "component_type": "carousel_quick_reply",
  "status": "enabled",
  "instruction": "string",
  "flow_id": 1,
  "id": "6bfebd43ddc270f6d2c56fc5",
  "created_at": 1,
  "updated_at": 1
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Business Agent