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"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Connect a WhatsApp server
Requires org:update. Stores the address, the instance and the api key of an Evolution server you run, and immediately asks it what state the instance is in.
Per environment, like every other credential here: the live instance is never reachable from a uk_sk_test_ key, which is what keeps a staging script from messaging real customers.
The address must be https — an api key travelling in a header over plaintext is a key anybody on the path can read, and that failure has no symptom. http://localhost is allowed for development.
Storing the credentials always succeeds or always fails; the health check that follows never fails the request. A server that did not answer is a repair, not a rejection, and the status tells you which repair.
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"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
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.
Cabeçalhos
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.
Parâmetros de caminho
The environment's id.
Corpo
Where the server answers, with no trailing slash.
"https://evo.exemplo.dev"
Which instance on that server sends. It is a path segment in every call we make.
200"vendas"
The server's own api key. Encrypted at rest and never returned.
500