Create UI Skill - YCloud Docs

{
  "id": "<string>",
  "title": "<string>",
  "component_type": "carousel_quick_reply",
  "status": "disabled",
  "instruction": "<string>",
  "flow_id": 123,
  "created_at": 123,
  "updated_at": 123
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

POST

https://api.ycloud.com/v2

/

metaBusinessAgents

/

{entityId}

/

uiSkills

{
  "id": "<string>",
  "title": "<string>",
  "component_type": "carousel_quick_reply",
  "status": "disabled",
  "instruction": "<string>",
  "flow_id": 123,
  "created_at": 123,
  "updated_at": 123
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

entityId

string

required

WhatsApp Business Phone Number ID that owns the Meta Business Agent.

Body

application/json

title

string

required

Minimum string length: 1

component_type

enum<string>

required

Rich WhatsApp component that the agent may present.

Available options:

carousel_quick_reply,

carousel_url,

cta_url,

flow,

image,

interactive_list,

interactive_reply_buttons,

location,

location_request

status

enum<string>

required

Whether the UI Skill is available to the agent.

Available options:

disabled,

enabled

instruction

string

required

Minimum string length: 1

flow_id

integer<int64>

Required only when component_type is flow; omit for every other component type.

Response

Operation completed successfully.

id

string

required

UI Skill resource ID.

title

string

required

Display title for the UI Skill.

component_type

enum<string>

required

Rich WhatsApp component that the agent may present.

Available options:

carousel_quick_reply,

carousel_url,

cta_url,

flow,

image,

interactive_list,

interactive_reply_buttons,

location,

location_request

status

enum<string>

required

Whether the UI Skill is available to the agent.

Available options:

disabled,

enabled

instruction

string

required

Instruction that tells the agent when to use this UI component.

flow_id

integer<int64>

WhatsApp Flow ID. Present only for a flow UI Skill.

created_at

integer<int64>

Meta creation timestamp as Unix epoch seconds.

updated_at

integer<int64>

Meta update timestamp as Unix epoch seconds.