A valid request URL is required to generate request examples{
"connection": {
"connected": true,
"base_url": "https://evo.exemplo.dev",
"instance": "vendas",
"status": "pending",
"status_detail": "<string>",
"checked_at": "2023-11-07T05:31:56Z"
},
"whatsapp_available": true
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Re-check the WhatsApp connection
Requires org:update. Asks the server what the instance is doing and records what it said.
Not having been able to ask leaves the status exactly as it was: a column that moved because our own network blinked would send you to reinstall a server that was fine.
The four answers are four repairs: connected (nothing to do), invalid_api_key (rotate it), disconnected (the phone is not paired — scan the QR code again), unreachable (the address answered with an error).
A valid request URL is required to generate request examples{
"connection": {
"connected": true,
"base_url": "https://evo.exemplo.dev",
"instance": "vendas",
"status": "pending",
"status_detail": "<string>",
"checked_at": "2023-11-07T05:31:56Z"
},
"whatsapp_available": true
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
The environment's id.