Design

Write a channel's design

Send only the fields you are changing. Anything you leave out keeps the value it had. Answers the whole channel, the same as GET.

autosave decides which copy you write. Leave it out and you write the live channel, and it is copied to the test one. Send true and you write only the test copy; the live channel then answers merged: false, meaning the two no longer match.

Needs the permission to create channels — not the one to edit bots.

patch/v1/channels/{channel_id}/

Request

  • Base URL: https://api.landbot.io
  • URL: https://api.landbot.io/v1/channels/{channel_id}/
  • Auth: one of:
    • API key in cookie sessionid
    • API key in header Authorization
    • HTTP bearer

Request body

autosaveboolean

Write the test side alone instead of the live channel. Left out, the write lands on the live channel and is copied to the test one.

namestring
brand_namestring
statusstring
logostring
faviconstring
taglinestring
designobject
stylestring
headstring
footstring
textobject
welcomeobject[]
persistent_menuobject[]
conditional_proactivesobject
typing_optionsobject
hidden_fieldsobject
launcher_configobject
revisitobject[]
revisit_offboolean
storage_offboolean
brandingboolean
is_legal_consent_enabledboolean
privacy_policy_linkstring
privacy_policy_link_textstring
privacy_policy_textstring
meta_titlestring
meta_imagestring
fb_pixel_idstring
google_analytics_idstring
widget_heightstring
formatstring
versionstring

Response

The channel after the change

successboolean required

Example response

{
  "channel": {
    "version": "3.0.0"
  }
}

Changes

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