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"
}
}Read the WhatsApp connection
Requires org:update. The Evolution server this environment sends WhatsApp messages through, and what the last health check saw.
The api key never comes back. You pasted it out of a console you administer; a panel that could read it back would be one more way out for it. What you get here is the address, the instance and the status.
whatsapp_available is false when the deployment has no encryption key at all — a credential we cannot encrypt is one we refuse to store, so no screen should offer the form.
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"
}
}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.