Create a UI skill

Create a new UI skill for the specified entity.

post

Authorizations

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Header parameters

X-API-Versionstring · enumOptional

Meta Business Agent API version

Possible values:

Body

UI skill to create

component_typestring · enumRequired

The type of rich message this UI skill sends

Example: cta_urlPossible values:

flow_idintegerOptional

The identifier of the flow to associate. Required when component_type is flow, and not supported otherwise

Example: 1234567890

instructionstringRequired

A description telling the AI agent when to send this UI skill

Example: Send this when the customer asks to browse the product catalog

statusstring · enumRequired

Whether this UI skill is enabled and available to the AI agent

Example: enabledPossible values:

titlestringRequired

A human-readable name for the UI skill

Example: Show the catalog carousel

Responses

201

The newly created UI skill

application/json

A single UI skill

component_typestring · enumRequired

The type of rich message this UI skill sends

Example: cta_urlPossible values:

created_atintegerRequired

The timestamp when the UI skill was created

Example: 1735689600

flow_idintegerOptional

The identifier of the associated flow. Only present for flow skills

Example: 1234567890

idstringRequired

A unique identifier for the UI skill

Example: 1234567890

instructionstringRequired

A description telling the AI agent when to send this UI skill

Example: Send this when the customer asks to browse the product catalog

statusstring · enumRequired

Whether this UI skill is enabled and available to the AI agent

Example: enabledPossible values:

titlestringRequired

A human-readable name for the UI skill

Example: Show the catalog carousel

updated_atintegerRequired

The timestamp when the UI skill was last updated

Example: 1735689600

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Server error

application/json

post/agent-ui-skills

POST /agent-ui-skills HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "component_type": "cta_url",
  "flow_id": 1234567890,
  "instruction": "Send this when the customer asks to browse the product catalog",
  "status": "enabled",
  "title": "Show the catalog carousel"
}

{
  "component_type": "cta_url",
  "created_at": 1735689600,
  "flow_id": 1234567890,
  "id": "1234567890",
  "instruction": "Send this when the customer asks to browse the product catalog",
  "status": "enabled",
  "title": "Show the catalog carousel",
  "updated_at": 1735689600
}