POST
/
apps
/
{appId}
/
extensions
/
widget
/
v2
/
settings
Chat Widgets Create
curl --request POST \
  --url https://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/settings \
  --header 'Content-Type: application/json' \
  --header 'key: <key>' \
  --header 'secret: <secret>' \
  --data '{
  "settings": {
    "name": "Test Chat Widget",
    "version": "v2",
    "style": {
      "custom_css": "<string>",
      "custom_js": "v2",
      "docked_layout_icon_background": "#03a9f4",
      "docked_layout_icon_close": "https://widget-js.cometchat.io/v2/resources/chat_close.svg",
      "docked_layout_icon_open": "https://widget-js.cometchat.io/v2/resources/chat_bubble.svg",
      "primary_color": "#03A9F4",
      "foreground_color": " #000000",
      "background_color": "#FFFFFF",
      "override_system_background_colors": true
    },
    "sidebar": {
      "chats": true,
      "users": true,
      "groups": true,
      "calls": true,
      "user_settings": true,
      "recent_chat_listing": "all_chats",
      "user_listing": "all_users",
      "sidebar_navigation_sequence": [
        "chats",
        "users",
        "groups",
        "calls",
        "settings"
      ],
      "start_a_new_conversation": "all_chats",
      "group_listing": "public_and_password_protected_groups"
    },
    "main": {
      "allow_add_members": true,
      "allow_creating_polls": true,
      "allow_delete_groups": true,
      "allow_kick_ban_members": true,
      "allow_message_reactions": true,
      "allow_moderator_to_delete_member_messages": true,
      "allow_promote_demote_members": true,
      "block_user": true,
      "create_groups": true,
      "enable_collaborative_document": true,
      "enable_collaborative_whiteboard": true,
      "enable_deleting_messages": true,
      "enable_editing_messages": true,
      "enable_message_translation": true,
      "enable_sending_messages": true,
      "enable_sound_for_calls": true,
      "enable_sound_for_messages": true,
      "enable_threaded_replies": true,
      "enable_video_calling": true,
      "enable_voice_calling": true,
      "hide_deleted_messages": true,
      "hide_join_leave_notifications": true,
      "join_or_leave_groups": true,
      "send_emojis": true,
      "send_files": true,
      "send_message_in_private_to_group_member": true,
      "send_photos_videos": true,
      "share_live_reactions": true,
      "show_call_notifications": true,
      "show_delivery_read_indicators": true,
      "show_emojis_in_larger_size": true,
      "show_stickers": true,
      "show_typing_indicators": true,
      "show_user_presence": true,
      "view_group_members": true,
      "allow_mention_members": false,
      "enable_replying_to_messages": false,
      "enable_share_copy_forward_messages": false,
      "highlight_messages_from_moderators": false,
      "show_call_recording_option": false,
      "send_voice_notes": false,
      "send_gifs": false,
      "share_location": false,
      "view_shared_media": true,
      "set_groups_in_qna_mode_by_moderators": false,
      "send_reply_in_private_to_group_member": false
    }
  }
}'
{
  "data": {
    "statusCode": 200,
    "success": true,
    "responseTime": 1.8547508716583252,
    "body": {
      "data": {
        "widgetId": "f7ee7c30-416b-4398-9edd-2595cefd676f"
      }
    }
  }
}

Headers

key
string
required

Authorization Key

secret
string
required

Authorization Secret

Path Parameters

appId
string
required

AppID in which the extension has to be enabled/disabled

Body

application/json

Response

200 - application/json

Create Chat Widget

The response is of type object.