POST

https://{server-url}

/
typebot
/
start
/
{instance}
curl --request POST \
  --url https://{server-url}/typebot/start/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "url": "<string>",
  "typebot": "<string>",
  "remoteJid": "<string>",
  "startSession": true,
  "variables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}'

Authorizations

apikey
string
headerrequired

Your authorization key header

Path Parameters

instance
string
required

ID of the instance to connect

Body

application/json
url
string

Typebot URL

typebot
string

Typebot name

remoteJid
string

Receiver remote JID

startSession
boolean

Start a new session

variables
object[]
Set TypebotFind Typebot