GUgupshup
Configure — UI Skills

Create UI skill

post/partner/app/{appId}/bizai/agent-ui-skills

Request

  • Base URL
    https://partner.gupshup.io
  • URL
    https://partner.gupshup.io/partner/app/{appId}/bizai/agent-ui-skills
  • Auth
    API key in header Authorization

Request body

titlestring required

Lowercase letters, digits and hyphens; no leading or trailing hyphen.

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
flow_idinteger

Required when component_type is flow, rejected otherwise. The flow must be published before the skill can be enabled.

Response

UI skill created.

idstring

Meta resource id.

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

Example response

{
  "id": "pfbid0GNkExampleExampleExample"
}

Changes

No recorded changes to this operation across all 1 revision of this API.