🏢 Tenant API

CreateApi

post

https://{{baseurl}}https://{{BaseUrl}}

/tenantCreateApi

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

namestringOpcional

sessionIdnumberOpcional

urlServiceStatusstring · anulávelOpcional

urlMessageStatusstring · anulávelOpcional

userIdnumberOpcional

authTokenstringOpcional

tenantnumberOpcional

Respostas

200

Successful response

application/json

post/tenantCreateApi

HTTPcURLJavaScriptPython

POST /tenantCreateApi HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "API 1",
  "sessionId": 1,
  "urlServiceStatus": null,
  "urlMessageStatus": null,
  "userId": 1,
  "authToken": "123456",
  "tenant": 1
}

200

Successful response

CreateSessionTenant

post

https://{{baseurl}}https://{{BaseUrl}}

/tenantApiCreateSession

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

tenantnumberOpcional

namestringOpcional

statusstringOpcional

typestringOpcional

Respostas

200

Successful response

application/json

post/tenantApiCreateSession

HTTPcURLJavaScriptPython

POST /tenantApiCreateSession HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "tenant": 1,
  "name": "My WhatsApp Instance",
  "status": "DISCONNECTED",
  "type": "baileys"
}

200

Successful response

DeleteApi

post

https://{{baseurl}}https://{{BaseUrl}}

/tenantDeleteApi

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

sessionIdnumberOpcional

userIdnumberOpcional

tenantnumberOpcional

apiIdstringOpcional

Respostas

200

Successful response

application/json

post/tenantDeleteApi

HTTPcURLJavaScriptPython

POST /tenantDeleteApi HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "sessionId": 43,
  "userId": 1,
  "tenant": 1,
  "apiId": "5ec32c80-4549-4256-8ed1-ed57b86396c3"
}

200

Successful response

ListTenants

get

https://{{baseurl}}https://{{BaseUrl}}

/tenantApiListTenants

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Respostas

200

Successful response

application/json

get/tenantApiListTenants

HTTPcURLJavaScriptPython

GET /tenantApiListTenants HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ShowTenant

post

https://{{baseurl}}https://{{BaseUrl}}

/tenantApiShowTenant

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idnumberOpcional

Respostas

200

Successful response

application/json

post/tenantApiShowTenant

HTTPcURLJavaScriptPython

POST /tenantApiShowTenant HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "id": 1
}

200

Successful response

StoreTenant

post

https://{{baseurl}}https://{{BaseUrl}}

/tenantApiStoreTenant

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

statusstringOpcional

namestringOpcional

maxUsersnumberOpcional

maxConnectionsnumberOpcional

acceptTermsbooleanOpcional

emailstringOpcional

passwordstringOpcional

userNamestringOpcional

profilestringOpcional

Respostas

200

Successful response

application/json

post/tenantApiStoreTenant

HTTPcURLJavaScriptPython

POST /tenantApiStoreTenant HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "status": "active",
  "name": "Empresa Exemplo",
  "maxUsers": 3,
  "maxConnections": 3,
  "acceptTerms": true,
  "email": "[e-mail]",
  "password": "securePassword123!",
  "userName": "Pedro Bastos",
  "profile": "admin"
}

200

Successful response

UpdateTenant

post

https://{{baseurl}}https://{{BaseUrl}}

/tenantApiUpdateTenant

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

identitystringOpcional

statusstringOpcional

maxUsersnumberOpcional

maxConnectionsnumberOpcional

paymentGatewaystringOpcional

supportChatEnabledstringOpcional

menuVisibilitystring[]Opcional

allowedChannelsstring[]Opcional

oauthEnabledbooleanOpcional

oauthProxyUrlstringOpcional

instagramWebhookProxyUrlstringOpcional

instagramWebhookProxySecretstringOpcional

messengerWebhookProxyUrlstringOpcional

messengerWebhookProxySecretstringOpcional

Respostas

200

Successful response

application/json

post/tenantApiUpdateTenant

HTTPcURLJavaScriptPython

POST /tenantApiUpdateTenant HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 942

{
  "identity": "07122989674",
  "status": "active",
  "maxUsers": 100,
  "maxConnections": 10,
  "paymentGateway": "asaas",
  "supportChatEnabled": "enabled",
  "menuVisibility": [
    "Groups",
    "MassDispatch",
    "Kanban",
    "Tasks",
    "Api",
    "ChatBot",
    "Reports",
    "Campaigns",
    "PrivateChat",
    "Teams",
    "AllowedChannels"
  ],
  "allowedChannels": [
    "waba",
    "baileys",
    "whatsapp",
    "meow",
    "evo",
    "zapi",
    "uazapi",
    "telegram",
    "hub",
    "webchat",
    "webmail",
    "wabaoauth",
    "instagramoauth",
    "facebookoauth"
  ],
  "channelConnectionLimits": {
    "waba": 0,
    "baileys": 0,
    "whatsapp": 0,
    "meow": 0,
    "evo": 0,
    "zapi": 0,
    "uazapi": 0,
    "telegram": 0,
    "hub": 0,
    "webchat": 0,
    "webmail": 0,
    "wabaoauth": 0,
    "instagramoauth": 0,
    "facebookoauth": 0
  },
  "oauthEnabled": false,
  "oauthProxyUrl": "https://proxy.exemplo.com/oauth",
  "instagramWebhookProxyUrl": "https://proxy.exemplo.com/instagram/webhook",
  "instagramWebhookProxySecret": "secret_instagram",
  "messengerWebhookProxyUrl": "https://proxy.exemplo.com/messenger/webhook",
  "messengerWebhookProxySecret": "secret_messenger"
}

200

Successful response