Sign in
Business Agent

Create a UI skill

Tells the agent when to send a rich component (CTA URL button, image, carousel, list, reply buttons, location, Flow) and what to put in it. Not idempotent.

post/v1/accounts/{accountId}/business-agent/ui-skills

Path parameters

accountIdstring required

WhatsApp social account id (the number must be managed through the Cloud API).

Request body

titlestring
component_type'carousel_quick_reply' | 'carousel_url' | 'cta_url' | 'flow' | 'image' | 'interactive_list' | 'interactive_reply_buttons' | 'location' | 'location_request' required
status'enabled' | 'disabled' required
instructionstring required

When to send the component and everything needed to fill its fields.

flow_idinteger

Required for component_type flow, rejected otherwise.

Response

UI skill created

titlestring
component_type'carousel_quick_reply' | 'carousel_url' | 'cta_url' | 'flow' | 'image' | 'interactive_list' | 'interactive_reply_buttons' | 'location' | 'location_request' required
status'enabled' | 'disabled' required
instructionstring required

When to send the component and everything needed to fill its fields.

flow_idinteger

Required for component_type flow, rejected otherwise.

idstring required
created_atinteger

Unix seconds.

updated_atinteger

Unix seconds.

Changes