Bots

POST /widgets

POST operation for /widgets

post/widgets

Request

  • Base URL: https://dev-rest.onboard.io
  • URL: https://dev-rest.onboard.io/widgets
  • Auth: API key in header Authorization

Request body

idinteger
botstring required
mode'light' | 'dark'
position'bottom_left' | 'bottom_right'
bot_logo_urlstring
bot_logostring binary
header_textstring
welcome_messagestring
show_powered_byboolean
is_email_requiredboolean
primary_colorstring
header_text_colorstring
background_colorstring
bot_message_bgstring
bot_message_textstring
user_message_bgstring
user_message_textstring
created_atstring date-time
modified_atstring date-time

Response

Successful response

idinteger
botstring required
mode'light' | 'dark'
position'bottom_left' | 'bottom_right'
bot_logo_urlstring
bot_logostring binary
header_textstring
welcome_messagestring
show_powered_byboolean
is_email_requiredboolean
primary_colorstring
header_text_colorstring
background_colorstring
bot_message_bgstring
bot_message_textstring
user_message_bgstring
user_message_textstring
created_atstring date-time
modified_atstring date-time

Changes

No recorded changes to this operation across all 3 revisions of this API.