🏢 Tenant API

CreateApi

post

Autorizações

AuthorizationstringObrigatório

Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: SuperAdminToken).

Corpo

namestringOpcional

Nome da API que será criada

Example: API 1

sessionIdintegerOpcional

ID da sessão do WhatsApp associada

Example: 1

urlServiceStatusstring · anulávelOpcional

URL para receber atualizações de status do serviço (opcional)

urlMessageStatusstring · anulávelOpcional

URL para receber atualizações de status das mensagens (opcional)

userIdintegerOpcional

ID do usuário que está criando a API

Example: 1

authTokenstringOpcional

Token de autenticação para a API

Example: 123456

tenantintegerOpcional

ID do tenant que terá a API

Example: 1

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/tenantCreateApi

POST /tenantCreateApi HTTP/1.1
Host: api.seudominio.com.br
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
}

{}

CreateSessionTenant

post

Endpoint com mais de um formato de payload na coleção oficial: CreateSessionTenant, CreateSessionTenant (Híbrido). Veja os exemplos do corpo para escolher a variante.

Autorizações

AuthorizationstringObrigatório

Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: SuperAdminToken).

Corpo

tenantintegerOpcional

Tenant

Example: 1

namestringOpcional

Nome da instância do WhatsApp

Example: My WhatsApp Instance

statusstringOpcional

Status inicial da sessão (DISCONNECTED, CONNECTED)

Example: DISCONNECTED

typestringOpcional

Tipo da sessão (whatsapp, baileys, zapo, meow, evo, uazapi, zapi)

Example: baileys

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/tenantApiCreateSession

POST /tenantApiCreateSession HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

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

{}

DeleteApi

post

Autorizações

AuthorizationstringObrigatório

Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: SuperAdminToken).

Corpo

sessionIdintegerOpcional

ID da sessão do WhatsApp associada à API

Example: 43

userIdintegerOpcional

ID do usuário que está deletando a API

Example: 1

tenantintegerOpcional

ID do tenant que possui a API

Example: 1

apiIdstringOpcional

ID da API que será deletada

Example: 5ec32c80-4549-4256-8ed1-ed57b86396c3

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/tenantDeleteApi

POST /tenantDeleteApi HTTP/1.1
Host: api.seudominio.com.br
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"
}

{}

ListTenants

get

Autorizações

AuthorizationstringObrigatório

Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: SuperAdminToken).

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

get/tenantApiListTenants

GET /tenantApiListTenants HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

ShowTenant

post

Autorizações

AuthorizationstringObrigatório

Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: SuperAdminToken).

Corpo

idintegerOpcional

ID do tenant que será consultado

Example: 1

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/tenantApiShowTenant

POST /tenantApiShowTenant HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "id": 1
}

{}

StoreTenant

post

Autorizações

AuthorizationstringObrigatório

Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: SuperAdminToken).

Corpo

statusstringOpcional

Status do tenant (active, inactive)

Example: active

namestringOpcional

Nome da empresa/tenant

Example: Empresa Exemplo

maxUsersintegerOpcional

Número máximo de usuários permitidos

Example: 3

maxConnectionsintegerOpcional

Número máximo de conexões WhatsApp permitidas

Example: 3

acceptTermsbooleanOpcional

Confirmação de aceite dos termos

Example: true

emailstringOpcional

Email do administrador do tenant

Example: user@example.com

passwordstringOpcional

Senha do administrador (mínimo 8 caracteres, incluindo números e caracteres especiais)

Example: securePassword123!

userNamestringOpcional

Nome completo do administrador

Example: Pedro Bastos

profilestringOpcional

Perfil do administrador (admin, user)

Example: admin

paymentGatewaystringOpcional

Vinculo de gateway de pagamento (OPCIONAL). Define qual gateway o webhook usa para atualizar o status de pagamento do tenant automaticamente. Valores: asaas, stripe, pagarme, mercadopago.

Example: stripe

stripeCustomerIdstringOpcional

Credenciais do gateway informado acima (envie apenas o par do gateway escolhido). Exemplo Stripe: Customer ID + Secret Key.

Example: cus_XXXXXXXXXXXXXX

stripeTokenstringOpcionalExample: sk_live_XXXXXXXXXXXXXXXX

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/tenantApiStoreTenant

POST /tenantApiStoreTenant HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "status": "active",
  "name": "Empresa Exemplo",
  "maxUsers": 3,
  "maxConnections": 3,
  "acceptTerms": true,
  "email": "user@example.com",
  "password": "securePassword123!",
  "userName": "Pedro Bastos",
  "profile": "admin",
  "paymentGateway": "stripe",
  "stripeCustomerId": "cus_XXXXXXXXXXXXXX",
  "stripeToken": "sk_live_XXXXXXXXXXXXXXXX"
}

{}

UpdateTenant

post

Autorizações

AuthorizationstringObrigatório

Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: SuperAdminToken).

Corpo

identitystringOpcional

Identidade do tenant (CPF/CNPJ) - identificador usado para reconhecer qual tenant será atualizado

Example: 7122989674

statusstringOpcional

Status do tenant (active, inactive)

Example: active

maxUsersintegerOpcional

Número máximo de usuários permitidos

Example: 100

maxConnectionsintegerOpcional

Número máximo de conexões permitidas

Example: 10

paymentGatewaystringOpcional

Gateway de pagamento (none, asaas, mercadopago, stripe, pagarme)

Example: asaas

supportChatEnabledstringOpcional

Credenciais do gateway (OPCIONAL) — envie o par correspondente ao paymentGateway. Ao trocar para um gateway nao-Asaas, o modo Asaas legado e desligado automaticamente. Stripe: "stripeCustomerId": "cus_xxx", "stripeToken": "sk_live_xxx" Pagar.me: "pagarmeCustomerId": "cus_xxx", "pagarmeToken": "sk_xxx" Mercado Pago: "mercadopagoCustomerId": "123456", "mercadopagoToken": "APP_USR-xxx" Chat de suporte habilitado (enabled, disabled)

Example: enabled

menuVisibilitystring[]Opcional

Menus visíveis — array de strings com os menus habilitados Opções: Groups, MassDispatch, Kanban, Tasks, Api, ChatBot, Reports, Campaigns, PrivateChat, Teams, AllowedChannels

Example: Groups

allowedChannelsstring[]Opcional

Canais permitidos — array de strings com os canais habilitados Opções: waba, baileys, zapo, whatsapp, meow, evo, zapi, uazapi, telegram, hub, webchat, webmail, wabaoauth, instagramoauth, facebookoauth

Example: waba

oauthEnabledbooleanOpcional

OAuth (Meta Embedded Signup) OAuth habilitado (true/false)

Example: false

oauthProxyUrlstringOpcional

URL do Proxy OAuth

Example: https://proxy.exemplo.com/oauth

instagramWebhookProxyUrlstringOpcional

URL do Proxy de Webhook Instagram

Example: https://proxy.exemplo.com/instagram/webhook

instagramWebhookProxySecretstringOpcional

Segredo do Proxy Instagram

Example: secret_instagram

messengerWebhookProxyUrlstringOpcional

URL do Proxy de Webhook Messenger

Example: https://proxy.exemplo.com/messenger/webhook

messengerWebhookProxySecretstringOpcional

Segredo do Proxy Messenger

Example: secret_messenger

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/tenantApiUpdateTenant

POST /tenantApiUpdateTenant HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 955

{
  "identity": 7122989674,
  "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",
    "zapo",
    "whatsapp",
    "meow",
    "evo",
    "zapi",
    "uazapi",
    "telegram",
    "hub",
    "webchat",
    "webmail",
    "wabaoauth",
    "instagramoauth",
    "facebookoauth"
  ],
  "channelConnectionLimits": {
    "waba": 0,
    "baileys": 0,
    "zapo": 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"
}

{}

Anterior📋 Templates WABA

Próximo🎫 Tickets

Atualizado há 1 mês

Isto foi útil?