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.

Path Parameters

  • channel_id
    Type: integer
    required

    The channel's integer id, which GET /v2/channels/ carries beside its uuid.

Body·

required
application/json

What you may write. Every field is optional; only the ones you send are written. A field not listed here is ignored rather than refused.

  • autosave
    Type: boolean

    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.

  • brand_name
    Type: string
  • branding
    Type: boolean
  • conditional_proactives
    Type: object
    Properties: 1
  • design
    Type: object
    Properties: 1
  • favicon
    Type: string
  • fb_pixel_id
    Type: string
  • foot
    Type: string
  • format
    Type: string
  • google_analytics_id
    Type: string
  • head
    Type: string
  • hidden_fields
    Type: object
    Properties: 1

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/v1/channels/{channel_id}/
curl https://api.landbot.io/v1/channels/1/ \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --cookie 'sessionid=YOUR_SECRET_TOKEN' \
  --data '{
  "autosave": true,
  "name": "",
  "brand_name": "",
  "status": "",
  "logo": "",
  "favicon": "",
  "tagline": "",
  "design": {
    "additionalProperty": "anything"
  },
  "style": "",
  "head": "",
  "foot": "",
  "text": {
    "additionalProperty": "anything"
  },
  "welcome": [
    {
      "additionalProperty": "anything"
    }
  ],
  "persistent_menu": [
    {
      "additionalProperty": "anything"
    }
  ],
  "conditional_proactives": {
    "additionalProperty": "anything"
  },
  "typing_options": {
    "additionalProperty": "anything"
  },
  "hidden_fields": {
    "additionalProperty": "anything"
  },
  "launcher_config": {
    "additionalProperty": "anything"
  },
  "revisit": [
    {
      "additionalProperty": "anything"
    }
  ],
  "revisit_off": true,
  "storage_off": true,
  "branding": true,
  "is_legal_consent_enabled": true,
  "privacy_policy_link": "",
  "privacy_policy_link_text": "",
  "privacy_policy_text": "",
  "meta_title": "",
  "meta_image": "",
  "fb_pixel_id": "",
  "google_analytics_id": "",
  "widget_height": "",
  "format": "",
  "version": ""
}'

{
  "success": true,
  "channel": {
    "id": 1,
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "type": "string",
    "merged": true,
    "token": "string",
    "config_url": "string",
    "design": {
      "additionalProperty": "anything"
    },
    "style": "string",
    "head": "string",
    "foot": "string",
    "logo": "string",
    "favicon": "string",
    "brand_name": "string",
    "status": "string",
    "tagline": "string",
    "url": "string",
    "welcome": [
      {
        "additionalProperty": "anything"
      }
    ],
    "persistent_menu": [
      {
        "additionalProperty": "anything"
      }
    ],
    "conditional_proactives": {
      "additionalProperty": "anything"
    },
    "launcher_config": {
      "additionalProperty": "anything"
    },
    "typing_options": {
      "additionalProperty": "anything"
    },
    "hidden_fields": {
      "additionalProperty": "anything"
    },
    "text": {
      "additionalProperty": "anything"
    },
    "version": "3.0.0",
    "additionalProperty": "anything"
  }
}

The channel after the change