Skip to main content
POST
/
instances
/
{id}
/
typebots
/
sessions
/
{session}
/
pause
Pause TypeBot session
curl --request POST \
  --url https://api.vzaps.com/instances/{id}/typebots/sessions/{session}/pause \
  --header 'Authorization: Bearer <token>'
{
  "status": "ok",
  "paused": 1,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Example:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

session
string<uuid>
required

TypeBot session UUID.

Response

OK

status
string
Example:

"ok"

paused
integer
Example:

1

session_id
string<uuid>