Skip to main content
POST
/
v1
/
sellits
/
{sellitId}
/
preview
/
startChat
Start preview chat
curl --request POST \
  --url https://sellitbr.com/api/v1/sellits/{sellitId}/preview/startChat \
  --header 'Content-Type: application/json' \
  --data '
{
  "isStreamEnabled": true,
  "message": "<string>",
  "isOnlyRegistering": true,
  "sellit": {
    "id": "<string>",
    "groups": [
      {
        "id": "<string>",
        "title": "<string>",
        "graphCoordinates": {
          "x": 123,
          "y": 123
        },
        "blocks": [
          {
            "id": "<string>",
            "type": "start",
            "label": "<string>",
            "outgoingEdgeId": "<string>"
          }
        ]
      }
    ],
    "events": "<array>",
    "edges": [
      {
        "id": "<string>",
        "from": {
          "blockId": "<string>",
          "itemId": "<string>"
        },
        "to": {
          "groupId": "<string>",
          "blockId": "<string>"
        }
      }
    ],
    "variables": [
      {
        "id": "<string>",
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "settings": {
      "general": {
        "isBrandingEnabled": true,
        "isTypingEmulationEnabled": true,
        "isInputPrefillEnabled": true,
        "isHideQueryParamsEnabled": true,
        "isNewResultOnRefreshEnabled": true,
        "rememberUser": {
          "isEnabled": true
        }
      },
      "typingEmulation": {
        "enabled": true,
        "speed": 123,
        "maxDelay": 123,
        "delayBetweenBubbles": 2.5,
        "isDisabledOnFirstMessage": true
      },
      "metadata": {
        "title": "<string>",
        "description": "<string>",
        "imageUrl": "<string>",
        "favIconUrl": "<string>",
        "customHeadCode": "<string>",
        "googleTagManagerId": "<string>"
      },
      "whatsApp": {
        "isEnabled": true,
        "sessionExpiryTimeout": 24.005
      },
      "publicShare": {
        "isEnabled": true
      },
      "security": {
        "allowedOrigins": [
          "<string>"
        ]
      }
    },
    "theme": {
      "general": {
        "font": "<string>",
        "background": {
          "content": "<string>"
        },
        "progressBar": {
          "isEnabled": true,
          "color": "<string>",
          "backgroundColor": "<string>",
          "thickness": 123
        }
      },
      "chat": {
        "hostAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "guestAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "hostBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "guestBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "buttons": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "inputs": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "placeholderColor": "<string>"
        }
      },
      "customCss": "<string>"
    }
  },
  "startFrom": {
    "type": "group",
    "groupId": "<string>"
  },
  "prefilledVariables": {
    "First name": "John",
    "Email": "john@gmail.com"
  }
}
'
import requests

url = "https://sellitbr.com/api/v1/sellits/{sellitId}/preview/startChat"

payload = {
    "isStreamEnabled": True,
    "message": "<string>",
    "isOnlyRegistering": True,
    "sellit": {
        "id": "<string>",
        "groups": [
            {
                "id": "<string>",
                "title": "<string>",
                "graphCoordinates": {
                    "x": 123,
                    "y": 123
                },
                "blocks": [
                    {
                        "id": "<string>",
                        "type": "start",
                        "label": "<string>",
                        "outgoingEdgeId": "<string>"
                    }
                ]
            }
        ],
        "events": "<array>",
        "edges": [
            {
                "id": "<string>",
                "from": {
                    "blockId": "<string>",
                    "itemId": "<string>"
                },
                "to": {
                    "groupId": "<string>",
                    "blockId": "<string>"
                }
            }
        ],
        "variables": [
            {
                "id": "<string>",
                "name": "<string>",
                "value": "<string>"
            }
        ],
        "settings": {
            "general": {
                "isBrandingEnabled": True,
                "isTypingEmulationEnabled": True,
                "isInputPrefillEnabled": True,
                "isHideQueryParamsEnabled": True,
                "isNewResultOnRefreshEnabled": True,
                "rememberUser": { "isEnabled": True }
            },
            "typingEmulation": {
                "enabled": True,
                "speed": 123,
                "maxDelay": 123,
                "delayBetweenBubbles": 2.5,
                "isDisabledOnFirstMessage": True
            },
            "metadata": {
                "title": "<string>",
                "description": "<string>",
                "imageUrl": "<string>",
                "favIconUrl": "<string>",
                "customHeadCode": "<string>",
                "googleTagManagerId": "<string>"
            },
            "whatsApp": {
                "isEnabled": True,
                "sessionExpiryTimeout": 24.005
            },
            "publicShare": { "isEnabled": True },
            "security": { "allowedOrigins": ["<string>"] }
        },
        "theme": {
            "general": {
                "font": "<string>",
                "background": { "content": "<string>" },
                "progressBar": {
                    "isEnabled": True,
                    "color": "<string>",
                    "backgroundColor": "<string>",
                    "thickness": 123
                }
            },
            "chat": {
                "hostAvatar": {
                    "isEnabled": True,
                    "url": "<string>"
                },
                "guestAvatar": {
                    "isEnabled": True,
                    "url": "<string>"
                },
                "hostBubbles": {
                    "backgroundColor": "<string>",
                    "color": "<string>"
                },
                "guestBubbles": {
                    "backgroundColor": "<string>",
                    "color": "<string>"
                },
                "buttons": {
                    "backgroundColor": "<string>",
                    "color": "<string>"
                },
                "inputs": {
                    "backgroundColor": "<string>",
                    "color": "<string>",
                    "placeholderColor": "<string>"
                }
            },
            "customCss": "<string>"
        }
    },
    "startFrom": {
        "type": "group",
        "groupId": "<string>"
    },
    "prefilledVariables": {
        "First name": "John",
        "Email": "john@gmail.com"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    isStreamEnabled: true,
    message: '<string>',
    isOnlyRegistering: true,
    sellit: {
      id: '<string>',
      groups: [
        {
          id: '<string>',
          title: '<string>',
          graphCoordinates: {x: 123, y: 123},
          blocks: [{id: '<string>', type: 'start', label: '<string>', outgoingEdgeId: '<string>'}]
        }
      ],
      events: '<array>',
      edges: [
        {
          id: '<string>',
          from: {blockId: '<string>', itemId: '<string>'},
          to: {groupId: '<string>', blockId: '<string>'}
        }
      ],
      variables: [{id: '<string>', name: '<string>', value: '<string>'}],
      settings: {
        general: {
          isBrandingEnabled: true,
          isTypingEmulationEnabled: true,
          isInputPrefillEnabled: true,
          isHideQueryParamsEnabled: true,
          isNewResultOnRefreshEnabled: true,
          rememberUser: {isEnabled: true}
        },
        typingEmulation: {
          enabled: true,
          speed: 123,
          maxDelay: 123,
          delayBetweenBubbles: 2.5,
          isDisabledOnFirstMessage: true
        },
        metadata: {
          title: '<string>',
          description: '<string>',
          imageUrl: '<string>',
          favIconUrl: '<string>',
          customHeadCode: '<string>',
          googleTagManagerId: '<string>'
        },
        whatsApp: {isEnabled: true, sessionExpiryTimeout: 24.005},
        publicShare: {isEnabled: true},
        security: {allowedOrigins: ['<string>']}
      },
      theme: {
        general: {
          font: '<string>',
          background: {content: '<string>'},
          progressBar: {
            isEnabled: true,
            color: '<string>',
            backgroundColor: '<string>',
            thickness: 123
          }
        },
        chat: {
          hostAvatar: {isEnabled: true, url: '<string>'},
          guestAvatar: {isEnabled: true, url: '<string>'},
          hostBubbles: {backgroundColor: '<string>', color: '<string>'},
          guestBubbles: {backgroundColor: '<string>', color: '<string>'},
          buttons: {backgroundColor: '<string>', color: '<string>'},
          inputs: {backgroundColor: '<string>', color: '<string>', placeholderColor: '<string>'}
        },
        customCss: '<string>'
      }
    },
    startFrom: {type: 'group', groupId: '<string>'},
    prefilledVariables: {'First name': 'John', Email: 'john@gmail.com'}
  })
};

fetch('https://sellitbr.com/api/v1/sellits/{sellitId}/preview/startChat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sellitbr.com/api/v1/sellits/{sellitId}/preview/startChat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'isStreamEnabled' => true,
    'message' => '<string>',
    'isOnlyRegistering' => true,
    'sellit' => [
        'id' => '<string>',
        'groups' => [
                [
                                'id' => '<string>',
                                'title' => '<string>',
                                'graphCoordinates' => [
                                                                'x' => 123,
                                                                'y' => 123
                                ],
                                'blocks' => [
                                                                [
                                                                                                                                'id' => '<string>',
                                                                                                                                'type' => 'start',
                                                                                                                                'label' => '<string>',
                                                                                                                                'outgoingEdgeId' => '<string>'
                                                                ]
                                ]
                ]
        ],
        'events' => '<array>',
        'edges' => [
                [
                                'id' => '<string>',
                                'from' => [
                                                                'blockId' => '<string>',
                                                                'itemId' => '<string>'
                                ],
                                'to' => [
                                                                'groupId' => '<string>',
                                                                'blockId' => '<string>'
                                ]
                ]
        ],
        'variables' => [
                [
                                'id' => '<string>',
                                'name' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'settings' => [
                'general' => [
                                'isBrandingEnabled' => true,
                                'isTypingEmulationEnabled' => true,
                                'isInputPrefillEnabled' => true,
                                'isHideQueryParamsEnabled' => true,
                                'isNewResultOnRefreshEnabled' => true,
                                'rememberUser' => [
                                                                'isEnabled' => true
                                ]
                ],
                'typingEmulation' => [
                                'enabled' => true,
                                'speed' => 123,
                                'maxDelay' => 123,
                                'delayBetweenBubbles' => 2.5,
                                'isDisabledOnFirstMessage' => true
                ],
                'metadata' => [
                                'title' => '<string>',
                                'description' => '<string>',
                                'imageUrl' => '<string>',
                                'favIconUrl' => '<string>',
                                'customHeadCode' => '<string>',
                                'googleTagManagerId' => '<string>'
                ],
                'whatsApp' => [
                                'isEnabled' => true,
                                'sessionExpiryTimeout' => 24.005
                ],
                'publicShare' => [
                                'isEnabled' => true
                ],
                'security' => [
                                'allowedOrigins' => [
                                                                '<string>'
                                ]
                ]
        ],
        'theme' => [
                'general' => [
                                'font' => '<string>',
                                'background' => [
                                                                'content' => '<string>'
                                ],
                                'progressBar' => [
                                                                'isEnabled' => true,
                                                                'color' => '<string>',
                                                                'backgroundColor' => '<string>',
                                                                'thickness' => 123
                                ]
                ],
                'chat' => [
                                'hostAvatar' => [
                                                                'isEnabled' => true,
                                                                'url' => '<string>'
                                ],
                                'guestAvatar' => [
                                                                'isEnabled' => true,
                                                                'url' => '<string>'
                                ],
                                'hostBubbles' => [
                                                                'backgroundColor' => '<string>',
                                                                'color' => '<string>'
                                ],
                                'guestBubbles' => [
                                                                'backgroundColor' => '<string>',
                                                                'color' => '<string>'
                                ],
                                'buttons' => [
                                                                'backgroundColor' => '<string>',
                                                                'color' => '<string>'
                                ],
                                'inputs' => [
                                                                'backgroundColor' => '<string>',
                                                                'color' => '<string>',
                                                                'placeholderColor' => '<string>'
                                ]
                ],
                'customCss' => '<string>'
        ]
    ],
    'startFrom' => [
        'type' => 'group',
        'groupId' => '<string>'
    ],
    'prefilledVariables' => [
        'First name' => 'John',
        'Email' => 'john@gmail.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sellitbr.com/api/v1/sellits/{sellitId}/preview/startChat"

	payload := strings.NewReader("{\n  \"isStreamEnabled\": true,\n  \"message\": \"<string>\",\n  \"isOnlyRegistering\": true,\n  \"sellit\": {\n    \"id\": \"<string>\",\n    \"groups\": [\n      {\n        \"id\": \"<string>\",\n        \"title\": \"<string>\",\n        \"graphCoordinates\": {\n          \"x\": 123,\n          \"y\": 123\n        },\n        \"blocks\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"start\",\n            \"label\": \"<string>\",\n            \"outgoingEdgeId\": \"<string>\"\n          }\n        ]\n      }\n    ],\n    \"events\": \"<array>\",\n    \"edges\": [\n      {\n        \"id\": \"<string>\",\n        \"from\": {\n          \"blockId\": \"<string>\",\n          \"itemId\": \"<string>\"\n        },\n        \"to\": {\n          \"groupId\": \"<string>\",\n          \"blockId\": \"<string>\"\n        }\n      }\n    ],\n    \"variables\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"settings\": {\n      \"general\": {\n        \"isBrandingEnabled\": true,\n        \"isTypingEmulationEnabled\": true,\n        \"isInputPrefillEnabled\": true,\n        \"isHideQueryParamsEnabled\": true,\n        \"isNewResultOnRefreshEnabled\": true,\n        \"rememberUser\": {\n          \"isEnabled\": true\n        }\n      },\n      \"typingEmulation\": {\n        \"enabled\": true,\n        \"speed\": 123,\n        \"maxDelay\": 123,\n        \"delayBetweenBubbles\": 2.5,\n        \"isDisabledOnFirstMessage\": true\n      },\n      \"metadata\": {\n        \"title\": \"<string>\",\n        \"description\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"favIconUrl\": \"<string>\",\n        \"customHeadCode\": \"<string>\",\n        \"googleTagManagerId\": \"<string>\"\n      },\n      \"whatsApp\": {\n        \"isEnabled\": true,\n        \"sessionExpiryTimeout\": 24.005\n      },\n      \"publicShare\": {\n        \"isEnabled\": true\n      },\n      \"security\": {\n        \"allowedOrigins\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"theme\": {\n      \"general\": {\n        \"font\": \"<string>\",\n        \"background\": {\n          \"content\": \"<string>\"\n        },\n        \"progressBar\": {\n          \"isEnabled\": true,\n          \"color\": \"<string>\",\n          \"backgroundColor\": \"<string>\",\n          \"thickness\": 123\n        }\n      },\n      \"chat\": {\n        \"hostAvatar\": {\n          \"isEnabled\": true,\n          \"url\": \"<string>\"\n        },\n        \"guestAvatar\": {\n          \"isEnabled\": true,\n          \"url\": \"<string>\"\n        },\n        \"hostBubbles\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"guestBubbles\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"buttons\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"inputs\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\",\n          \"placeholderColor\": \"<string>\"\n        }\n      },\n      \"customCss\": \"<string>\"\n    }\n  },\n  \"startFrom\": {\n    \"type\": \"group\",\n    \"groupId\": \"<string>\"\n  },\n  \"prefilledVariables\": {\n    \"First name\": \"John\",\n    \"Email\": \"john@gmail.com\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sellitbr.com/api/v1/sellits/{sellitId}/preview/startChat")
  .header("Content-Type", "application/json")
  .body("{\n  \"isStreamEnabled\": true,\n  \"message\": \"<string>\",\n  \"isOnlyRegistering\": true,\n  \"sellit\": {\n    \"id\": \"<string>\",\n    \"groups\": [\n      {\n        \"id\": \"<string>\",\n        \"title\": \"<string>\",\n        \"graphCoordinates\": {\n          \"x\": 123,\n          \"y\": 123\n        },\n        \"blocks\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"start\",\n            \"label\": \"<string>\",\n            \"outgoingEdgeId\": \"<string>\"\n          }\n        ]\n      }\n    ],\n    \"events\": \"<array>\",\n    \"edges\": [\n      {\n        \"id\": \"<string>\",\n        \"from\": {\n          \"blockId\": \"<string>\",\n          \"itemId\": \"<string>\"\n        },\n        \"to\": {\n          \"groupId\": \"<string>\",\n          \"blockId\": \"<string>\"\n        }\n      }\n    ],\n    \"variables\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"settings\": {\n      \"general\": {\n        \"isBrandingEnabled\": true,\n        \"isTypingEmulationEnabled\": true,\n        \"isInputPrefillEnabled\": true,\n        \"isHideQueryParamsEnabled\": true,\n        \"isNewResultOnRefreshEnabled\": true,\n        \"rememberUser\": {\n          \"isEnabled\": true\n        }\n      },\n      \"typingEmulation\": {\n        \"enabled\": true,\n        \"speed\": 123,\n        \"maxDelay\": 123,\n        \"delayBetweenBubbles\": 2.5,\n        \"isDisabledOnFirstMessage\": true\n      },\n      \"metadata\": {\n        \"title\": \"<string>\",\n        \"description\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"favIconUrl\": \"<string>\",\n        \"customHeadCode\": \"<string>\",\n        \"googleTagManagerId\": \"<string>\"\n      },\n      \"whatsApp\": {\n        \"isEnabled\": true,\n        \"sessionExpiryTimeout\": 24.005\n      },\n      \"publicShare\": {\n        \"isEnabled\": true\n      },\n      \"security\": {\n        \"allowedOrigins\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"theme\": {\n      \"general\": {\n        \"font\": \"<string>\",\n        \"background\": {\n          \"content\": \"<string>\"\n        },\n        \"progressBar\": {\n          \"isEnabled\": true,\n          \"color\": \"<string>\",\n          \"backgroundColor\": \"<string>\",\n          \"thickness\": 123\n        }\n      },\n      \"chat\": {\n        \"hostAvatar\": {\n          \"isEnabled\": true,\n          \"url\": \"<string>\"\n        },\n        \"guestAvatar\": {\n          \"isEnabled\": true,\n          \"url\": \"<string>\"\n        },\n        \"hostBubbles\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"guestBubbles\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"buttons\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"inputs\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\",\n          \"placeholderColor\": \"<string>\"\n        }\n      },\n      \"customCss\": \"<string>\"\n    }\n  },\n  \"startFrom\": {\n    \"type\": \"group\",\n    \"groupId\": \"<string>\"\n  },\n  \"prefilledVariables\": {\n    \"First name\": \"John\",\n    \"Email\": \"john@gmail.com\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sellitbr.com/api/v1/sellits/{sellitId}/preview/startChat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isStreamEnabled\": true,\n  \"message\": \"<string>\",\n  \"isOnlyRegistering\": true,\n  \"sellit\": {\n    \"id\": \"<string>\",\n    \"groups\": [\n      {\n        \"id\": \"<string>\",\n        \"title\": \"<string>\",\n        \"graphCoordinates\": {\n          \"x\": 123,\n          \"y\": 123\n        },\n        \"blocks\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"start\",\n            \"label\": \"<string>\",\n            \"outgoingEdgeId\": \"<string>\"\n          }\n        ]\n      }\n    ],\n    \"events\": \"<array>\",\n    \"edges\": [\n      {\n        \"id\": \"<string>\",\n        \"from\": {\n          \"blockId\": \"<string>\",\n          \"itemId\": \"<string>\"\n        },\n        \"to\": {\n          \"groupId\": \"<string>\",\n          \"blockId\": \"<string>\"\n        }\n      }\n    ],\n    \"variables\": [\n      {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"settings\": {\n      \"general\": {\n        \"isBrandingEnabled\": true,\n        \"isTypingEmulationEnabled\": true,\n        \"isInputPrefillEnabled\": true,\n        \"isHideQueryParamsEnabled\": true,\n        \"isNewResultOnRefreshEnabled\": true,\n        \"rememberUser\": {\n          \"isEnabled\": true\n        }\n      },\n      \"typingEmulation\": {\n        \"enabled\": true,\n        \"speed\": 123,\n        \"maxDelay\": 123,\n        \"delayBetweenBubbles\": 2.5,\n        \"isDisabledOnFirstMessage\": true\n      },\n      \"metadata\": {\n        \"title\": \"<string>\",\n        \"description\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"favIconUrl\": \"<string>\",\n        \"customHeadCode\": \"<string>\",\n        \"googleTagManagerId\": \"<string>\"\n      },\n      \"whatsApp\": {\n        \"isEnabled\": true,\n        \"sessionExpiryTimeout\": 24.005\n      },\n      \"publicShare\": {\n        \"isEnabled\": true\n      },\n      \"security\": {\n        \"allowedOrigins\": [\n          \"<string>\"\n        ]\n      }\n    },\n    \"theme\": {\n      \"general\": {\n        \"font\": \"<string>\",\n        \"background\": {\n          \"content\": \"<string>\"\n        },\n        \"progressBar\": {\n          \"isEnabled\": true,\n          \"color\": \"<string>\",\n          \"backgroundColor\": \"<string>\",\n          \"thickness\": 123\n        }\n      },\n      \"chat\": {\n        \"hostAvatar\": {\n          \"isEnabled\": true,\n          \"url\": \"<string>\"\n        },\n        \"guestAvatar\": {\n          \"isEnabled\": true,\n          \"url\": \"<string>\"\n        },\n        \"hostBubbles\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"guestBubbles\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"buttons\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\"\n        },\n        \"inputs\": {\n          \"backgroundColor\": \"<string>\",\n          \"color\": \"<string>\",\n          \"placeholderColor\": \"<string>\"\n        }\n      },\n      \"customCss\": \"<string>\"\n    }\n  },\n  \"startFrom\": {\n    \"type\": \"group\",\n    \"groupId\": \"<string>\"\n  },\n  \"prefilledVariables\": {\n    \"First name\": \"John\",\n    \"Email\": \"john@gmail.com\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "sessionId": "<string>",
  "sellit": {
    "id": "<string>",
    "theme": {
      "general": {
        "font": "<string>",
        "background": {
          "content": "<string>"
        },
        "progressBar": {
          "isEnabled": true,
          "color": "<string>",
          "backgroundColor": "<string>",
          "thickness": 123
        }
      },
      "chat": {
        "hostAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "guestAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "hostBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "guestBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "buttons": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "inputs": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "placeholderColor": "<string>"
        }
      },
      "customCss": "<string>"
    },
    "settings": {
      "general": {
        "isBrandingEnabled": true,
        "isTypingEmulationEnabled": true,
        "isInputPrefillEnabled": true,
        "isHideQueryParamsEnabled": true,
        "isNewResultOnRefreshEnabled": true,
        "rememberUser": {
          "isEnabled": true
        }
      },
      "typingEmulation": {
        "enabled": true,
        "speed": 123,
        "maxDelay": 123,
        "delayBetweenBubbles": 2.5,
        "isDisabledOnFirstMessage": true
      },
      "metadata": {
        "title": "<string>",
        "description": "<string>",
        "imageUrl": "<string>",
        "favIconUrl": "<string>",
        "customHeadCode": "<string>",
        "googleTagManagerId": "<string>"
      },
      "whatsApp": {
        "isEnabled": true,
        "startCondition": {
          "comparisons": [
            {
              "id": "<string>",
              "value": "<string>"
            }
          ]
        },
        "sessionExpiryTimeout": 24.005
      },
      "publicShare": {
        "isEnabled": true
      },
      "security": {
        "allowedOrigins": [
          "<string>"
        ]
      }
    }
  },
  "messages": [
    {
      "id": "<string>",
      "type": "text",
      "content": {
        "html": "<string>",
        "richText": [
          "<unknown>"
        ],
        "plainText": "<string>"
      }
    }
  ],
  "lastMessageNewFormat": "<string>",
  "input": {
    "id": "<string>",
    "type": "text input",
    "outgoingEdgeId": "<string>",
    "options": {
      "labels": {
        "placeholder": "<string>",
        "button": "<string>"
      },
      "variableId": "<string>",
      "isLong": true
    },
    "prefilledValue": "<string>",
    "runtimeOptions": {
      "paymentIntentSecret": "<string>",
      "amountLabel": "<string>",
      "publicKey": "<string>"
    }
  },
  "clientSideActions": [
    {
      "type": "scriptToExecute",
      "scriptToExecute": {
        "content": "<string>",
        "args": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      },
      "lastBubbleBlockId": "<string>",
      "expectsDedicatedReply": true
    }
  ],
  "logs": [
    {
      "status": "<string>",
      "description": "<string>",
      "details": "<unknown>"
    }
  ],
  "dynamicTheme": {
    "hostAvatarUrl": "<string>",
    "guestAvatarUrl": "<string>"
  },
  "progress": 123
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Path Parameters

​
sellitId
string
required

Where to find my bot's ID?

Body

application/json
​
isStreamEnabled
boolean
​
message
string
​
isOnlyRegistering
boolean

If set to true, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message.

​
sellit
Sellit V5 · object

If set, it will override the sellit that is used to start the chat.

​
startFrom
object
​
prefilledVariables
object
Example:
{
  "First name": "John",
  "Email": "john@gmail.com"
}

Response

Successful response

​
sessionId
string
required

To save and use for /continueChat requests.

​
sellit
object
required
​
messages
(Text · object | Image · object | Video · object | Audio · object | Embed · object | Custom embed · object)[]
required
​
lastMessageNewFormat
string

The sent message is validated and formatted on the backend. For example, if for a date input you replied something like tomorrow, the backend will convert it to a date string. This field returns the formatted message.

​
input
Text · object
​
clientSideActions
(Script to execute · object | Redirect · object | Chatwoot · object | Google Analytics · object | Wait · object | Set variable · object | Stream OpenAI · object | Execute webhook · object | Inject start props · object | Init Pixel · object | Exec stream · object | Execute code · object)[]

Actions to execute on the client side

​
logs
object[]

Logs that were saved during the last execution

​
dynamicTheme
object

If the sellit contains dynamic avatars, dynamicTheme returns the new avatar URLs whenever their variables are updated.

​
progress
number

If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow.