Contas | Desenvolvedores | Documentação

Listar

get

Para autenticar nos endpoints de Gestão de Contas, utilize o Token de Parceiro. O token pode ser gerado na plataforma em Admin > Personalizar > Integração. Envie-o no header Authorization com o schema Bearer. Este token é exclusivo para os endpoints de Gestão de Contas e Parceiros. Listagem paginada de contas.

Autorizações

Parâmetros de consulta

SearchableTextstringOpcional

Texto para busca

OnlyInactivebooleanOpcional

Filtrar apenas contas inativas

Statusstring · enumOpcional

Status da conta

Valores possíveis:

SetupStatusstring · enumOpcional

Status de configuração da conta

Valores possíveis:

CreatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

PageNumberinteger · int32 · máx: 2147483647Opcional

Número da página a ser obtida.

Default: 1

PageSizeinteger · int32 · mín: 1 · máx: 100Opcional

Tamanho da página a ser obtida.

Default: 15

OrderBystringOpcional

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirectionstring · enumOpcional

Determina se a ordenação deve ser crescente ou decrescente.

Valores possíveis:

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/company

GET /core/v1/company HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:38.254Z",
      "updatedAt": "2025-11-06T22:36:38.254Z",
      "active": true,
      "legalName": "text",
      "documentType": "CPF",
      "documentId": "text",
      "name": "text",
      "partnerName": "text",
      "ownerId": "123e4567-e89b-12d3-a456-426614174000",
      "category": "text",
      "customCategory": "text",
      "type": "UNDEFINED",
      "invoiceType": "HELENA",
      "partnerId": "123e4567-e89b-12d3-a456-426614174000",
      "pictureUrl": "text",
      "wppNumber": "text",
      "phoneNumber": "text",
      "phoneNumberFormatted": "text",
      "email": "text",
      "defaultDepartmentId": "123e4567-e89b-12d3-a456-426614174000",
      "address": {
        "country": "text",
        "state": "text",
        "city": "text",
        "neighborhood": "text",
        "zipcode": "text",
        "number": "text",
        "address1": "text",
        "address2": "text"
      },
      "setupStatus": "DEMO",
      "config": {
        "planName": "text",
        "campaignEnabled": true,
        "panelEnabled": true,
        "customFieldEnabled": true,
        "webhookEnabled": true,
        "advancedChatbotEnabled": true,
        "resources": {
          "includedSessions": 1,
          "includedAgents": 1,
          "includedPanels": 1,
          "includedChatbots": 1,
          "includedChatbotAutomations": 1,
          "includedWhatsAppChannels": 1,
          "includedInstagramChannels": 1,
          "includedMessengerChannels": 1,
          "includedSequences": 1
        }
      }
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Criar

post

Autorizações

Corpo

DTO para criar uma nova conta

documentTypestring · enumOpcional

Tipo de documento (CPF ou CNPJ)

Valores possíveis:

documentIdstring | nuloOpcional

Número do documento (CPF ou CNPJ)

legalNamestring | nuloOpcional

Razão social da empresa

namestring | nuloOpcional

Nome fantasia da empresa

categorystring | nuloOpcional

Categoria da empresa

customCategorystring | nuloOpcional

Categoria personalizada da empresa

typestring · enumOpcional

Tipo da conta

Valores possíveis:

statusstring · enumOpcional

Status da conta

Valores possíveis:

Respostas

200

Success

application/json

500

Server Error

application/json

post

/v1/company

POST /core/v1/company HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 439

{
  "documentType": "CPF",
  "documentId": "text",
  "legalName": "text",
  "name": "text",
  "owner": {
    "name": "text",
    "email": "text",
    "phoneNumber": "text"
  },
  "category": "text",
  "customCategory": "text",
  "type": "UNDEFINED",
  "status": "DEMO",
  "apps": [
    "MESSAGE_DELAY"
  ],
  "resourcers": [
    "WEBHOOK_API"
  ],
  "config": {
    "session": 1,
    "agents": 1,
    "panels": 1,
    "chatBots": 1,
    "chatbotAutomations": 1,
    "whatsAppChannels": 1,
    "instagramChannels": 1,
    "messengerChannels": 1,
    "sequences": 1,
    "aiAgents": 1
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "active": true,
  "legalName": "text",
  "documentType": "CPF",
  "documentId": "text",
  "name": "text",
  "partnerName": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "category": "text",
  "customCategory": "text",
  "type": "UNDEFINED",
  "invoiceType": "HELENA",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "pictureUrl": "text",
  "wppNumber": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "email": "text",
  "defaultDepartmentId": "123e4567-e89b-12d3-a456-426614174000",
  "address": {
    "country": "text",
    "state": "text",
    "city": "text",
    "neighborhood": "text",
    "zipcode": "text",
    "number": "text",
    "address1": "text",
    "address2": "text"
  },
  "setupStatus": "DEMO",
  "config": {
    "planName": "text",
    "campaignEnabled": true,
    "panelEnabled": true,
    "customFieldEnabled": true,
    "webhookEnabled": true,
    "advancedChatbotEnabled": true,
    "resources": {
      "includedSessions": 1,
      "includedAgents": 1,
      "includedPanels": 1,
      "includedChatbots": 1,
      "includedChatbotAutomations": 1,
      "includedWhatsAppChannels": 1,
      "includedInstagramChannels": 1,
      "includedMessengerChannels": 1,
      "includedSequences": 1
    }
  }
}

Obter por ID

get

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID da conta

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/company/{id}

GET /core/v1/company/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "active": true,
  "legalName": "text",
  "documentType": "CPF",
  "documentId": "text",
  "name": "text",
  "partnerName": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "category": "text",
  "customCategory": "text",
  "type": "UNDEFINED",
  "invoiceType": "HELENA",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "pictureUrl": "text",
  "wppNumber": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "email": "text",
  "defaultDepartmentId": "123e4567-e89b-12d3-a456-426614174000",
  "address": {
    "country": "text",
    "state": "text",
    "city": "text",
    "neighborhood": "text",
    "zipcode": "text",
    "number": "text",
    "address1": "text",
    "address2": "text"
  },
  "setupStatus": "DEMO",
  "config": {
    "planName": "text",
    "campaignEnabled": true,
    "panelEnabled": true,
    "customFieldEnabled": true,
    "webhookEnabled": true,
    "advancedChatbotEnabled": true,
    "resources": {
      "includedSessions": 1,
      "includedAgents": 1,
      "includedPanels": 1,
      "includedChatbots": 1,
      "includedChatbotAutomations": 1,
      "includedWhatsAppChannels": 1,
      "includedInstagramChannels": 1,
      "includedMessengerChannels": 1,
      "includedSequences": 1
    }
  }
}

Atualizar

put

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID da conta.

Corpo

DTO para atualizar uma conta existente

legalNamestring | nuloOpcional

Razão social da empresa

namestring | nuloOpcional

Nome fantasia da empresa

categorystring | nuloOpcional

Categoria da empresa

customCategorystring | nuloOpcional

Categoria personalizada da empresa

phoneNumberstring | nuloOpcional

Número de telefone

emailstring | nuloOpcional

Email de contato

setupStatusstring · enum | nuloOpcional

Status de configuração da conta

Valores possíveis:

Respostas

200

Success

application/json

500

Server Error

application/json

put

/v1/company/{id}

PUT /core/v1/company/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "fields": [
    "LegalName"
  ],
  "legalName": "text",
  "name": "text",
  "category": "text",
  "customCategory": "text",
  "phoneNumber": "text",
  "email": "text",
  "address": {
    "country": "text",
    "state": "text",
    "city": "text",
    "neighborhood": "text",
    "zipcode": "text",
    "number": "text",
    "address1": "text",
    "address2": "text"
  },
  "apps": [
    "MESSAGE_DELAY"
  ],
  "resourcers": [
    "WEBHOOK_API"
  ],
  "config": {
    "session": 1,
    "agents": 1,
    "panels": 1,
    "chatBots": 1,
    "chatbotAutomations": 1,
    "whatsAppChannels": 1,
    "instagramChannels": 1,
    "messengerChannels": 1,
    "sequences": 1,
    "aiAgents": 1
  },
  "setupStatus": "DEMO"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "active": true,
  "legalName": "text",
  "documentType": "CPF",
  "documentId": "text",
  "name": "text",
  "partnerName": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "category": "text",
  "customCategory": "text",
  "type": "UNDEFINED",
  "invoiceType": "HELENA",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "pictureUrl": "text",
  "wppNumber": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "email": "text",
  "defaultDepartmentId": "123e4567-e89b-12d3-a456-426614174000",
  "address": {
    "country": "text",
    "state": "text",
    "city": "text",
    "neighborhood": "text",
    "zipcode": "text",
    "number": "text",
    "address1": "text",
    "address2": "text"
  },
  "setupStatus": "DEMO",
  "config": {
    "planName": "text",
    "campaignEnabled": true,
    "panelEnabled": true,
    "customFieldEnabled": true,
    "webhookEnabled": true,
    "advancedChatbotEnabled": true,
    "resources": {
      "includedSessions": 1,
      "includedAgents": 1,
      "includedPanels": 1,
      "includedChatbots": 1,
      "includedChatbotAutomations": 1,
      "includedWhatsAppChannels": 1,
      "includedInstagramChannels": 1,
      "includedMessengerChannels": 1,
      "includedSequences": 1
    }
  }
}

Excluir

delete

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID da conta a ser excluída.

Respostas

200

Success

Sem conteúdo

500

Server Error

application/json

delete

/v1/company/{id}

DELETE /core/v1/company/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

Sem conteúdo

Ativar

post

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID da conta a ser ativada.

Respostas

200

Success

application/json

500

Server Error

application/json

post

/v1/company/{id}/active

POST /core/v1/company/{id}/active HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "active": true,
  "legalName": "text",
  "documentType": "CPF",
  "documentId": "text",
  "name": "text",
  "partnerName": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "category": "text",
  "customCategory": "text",
  "type": "UNDEFINED",
  "invoiceType": "HELENA",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "pictureUrl": "text",
  "wppNumber": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "email": "text",
  "defaultDepartmentId": "123e4567-e89b-12d3-a456-426614174000",
  "address": {
    "country": "text",
    "state": "text",
    "city": "text",
    "neighborhood": "text",
    "zipcode": "text",
    "number": "text",
    "address1": "text",
    "address2": "text"
  },
  "setupStatus": "DEMO",
  "config": {
    "planName": "text",
    "campaignEnabled": true,
    "panelEnabled": true,
    "customFieldEnabled": true,
    "webhookEnabled": true,
    "advancedChatbotEnabled": true,
    "resources": {
      "includedSessions": 1,
      "includedAgents": 1,
      "includedPanels": 1,
      "includedChatbots": 1,
      "includedChatbotAutomations": 1,
      "includedWhatsAppChannels": 1,
      "includedInstagramChannels": 1,
      "includedMessengerChannels": 1,
      "includedSequences": 1
    }
  }
}

Listar tokens da conta

get

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID da conta

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/company/{id}/tokens

GET /core/v1/company/{id}/tokens HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "token": "text",
    "name": "text",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-11-06T22:36:38.254Z",
    "updatedAt": "2025-11-06T22:36:38.254Z",
    "partnerId": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Criar novo token

post

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID da conta

Corpo

namestring | nuloOpcional

Nome do token

Respostas

200

Success

application/json

500

Server Error

application/json

post

/v1/company/{id}/tokens

POST /core/v1/company/{id}/tokens HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "text",
  "name": "text",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": "123e4567-e89b-12d3-a456-426614174000"
}

Remover token

delete

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID da conta

tokenIdstring · uuidObrigatório

ID do token a ser apagado

Respostas

200

Success

Sem conteúdo

500

Server Error

application/json

delete

/v1/company/{id}/tokens/{tokenId}

DELETE /core/v1/company/{id}/tokens/{tokenId} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

Sem conteúdo