API do Organizap — Documentação Completa
Referência da API · v2

Integre tudo ao Organizap com uma API completa e organizada.

Documentação oficial dos endpoints da plataforma 360º de atendimento por WhatsApp. Mais de 25 áreas de integração cobrindo mensageria, CRM, atendimento, automações e relatórios — tudo pronto para conectar seu sistema.

Padrão
REST · JSON
Autenticação
Token Bearer
Disponibilidade
24/7 · 99,9% uptime

Comece a integrar em poucos passos

A API do Organizap segue o padrão REST e usa JSON em todas as requisições e respostas. Você precisa apenas do seu token de autenticação para começar.

  • 1Acesse sua conta no Organizap e gere um token de API em Configurações → Integrações.
  • 2Inclua o token no cabeçalho Authorization de cada requisição.
  • 3Clique em qualquer card abaixo para ver os endpoints daquela área.
  • 4Em caso de dúvida, fale com nossa equipe de suporte técnico via WhatsApp.
Exemplo · Envio de mensagem
POST /v2/api/external/{ApiID} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "body": "Olá! Sua compra foi confirmada.", "number": "5532998598896" }
Total de áreas: 25
Nenhum endpoint encontrado.
Tente refinar sua busca com outros termos.

Pronto para integrar com o Organizap?

Nossa equipe técnica está disponível para ajudar com a integração, revisão da arquitetura ou qualquer dúvida sobre os endpoints.

Falar com a equipe técnica

AppointmentCreate

AppointmentCreate
POST /v2/api/external/{ApiID}/appointment/create
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
titlestringOpcionalTítulo.
descriptionstringOpcionalDescrição detalhada.
contactIdstringOpcionalID do contato vinculado.
startAtstringOpcionalData/hora de início (ISO 8601).
endAtstringOpcionalData/hora de término (ISO 8601).
statusstringOpcionalStatus atual.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/appointment/create Authorization: Bearer SEU_TOKEN Content-Type: application/json { "title": "valor", "description": "valor", "contactId": "valor", "startAt": "valor", "endAt": "valor", "status": "valor" }

AppointmentDelete

AppointmentDelete
POST /v2/api/external/{ApiID}/appointment/delete/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/appointment/delete/{id} Authorization: Bearer SEU_TOKEN

AppointmentList

AppointmentList
GET /v2/api/external/{ApiID}/appointment/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
statusstringOpcionalStatus atual.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/appointment/list Authorization: Bearer SEU_TOKEN

AppointmentShow

AppointmentShow
GET /v2/api/external/{ApiID}/appointment/show/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/appointment/show/{id} Authorization: Bearer SEU_TOKEN

AppointmentUpdate

AppointmentUpdate
POST /v2/api/external/{ApiID}/appointment/update/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
statusstringOpcionalStatus atual.
notesstringOpcionalAnotações.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/appointment/update/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "status": "valor", "notes": "valor" }

ScheduleReminderCreate

ScheduleReminderCreate
POST /v2/api/external/{ApiID}/scheduleReminder/create
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
hoursBeforeEventnumberOpcionalQuantas horas antes do evento o lembrete será disparado.
messageTypestringOpcionalTipo da mensagem (text, template, etc.).
messageContentstringOpcionalConteúdo da mensagem enviada.
activebooleanOpcionalDefine se está ativo.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/scheduleReminder/create Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "hoursBeforeEvent": 1, "messageType": "valor", "messageContent": "valor", "active": true }

ScheduleReminderDelete

ScheduleReminderDelete
POST /v2/api/external/{ApiID}/scheduleReminder/delete/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/scheduleReminder/delete/{id} Authorization: Bearer SEU_TOKEN

ScheduleReminderList

ScheduleReminderList
GET /v2/api/external/{ApiID}/scheduleReminder/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/scheduleReminder/list Authorization: Bearer SEU_TOKEN

ScheduleReminderToggle

ScheduleReminderToggle
POST /v2/api/external/{ApiID}/scheduleReminder/toggle/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/scheduleReminder/toggle/{id} Authorization: Bearer SEU_TOKEN

ScheduleReminderUpdate

ScheduleReminderUpdate
POST /v2/api/external/{ApiID}/scheduleReminder/update/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
hoursBeforeEventnumberOpcionalQuantas horas antes do evento o lembrete será disparado.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/scheduleReminder/update/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "hoursBeforeEvent": 1 }

CampaignCancel

CampaignCancel
POST /v2/api/external/{ApiID}/campaign/cancel/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/cancel/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignContactsAdd

CampaignContactsAdd
POST /v2/api/external/{ApiID}/campaign/contacts/add/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

A requisição espera um array de objetos com os seguintes campos:

CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
numberstringOpcionalNúmero do contato (formato 5511999999999).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/contacts/add/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json [{ "name": "valor", "number": "valor" }]

CampaignContactsList

CampaignContactsList
GET /v2/api/external/{ApiID}/campaign/contacts/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/campaign/contacts/{campaignId} Authorization: Bearer SEU_TOKEN

CampaignContactsRemove

CampaignContactsRemove
POST /v2/api/external/{ApiID}/campaign/contacts/remove/{campaignId}/{contactId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
contactIdstringObrigatórioID do contato vinculado.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/contacts/remove/{campaignId}/{contactId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignContactsRemoveAll

CampaignContactsRemoveAll
POST /v2/api/external/{ApiID}/campaign/contacts/removeAll/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/contacts/removeAll/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignCreate

CampaignCreate
POST /v2/api/external/{ApiID}/campaign/create
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
startstringOpcionalData/hora de início.
message1stringOpcionalPrimeira mensagem da sequência.
message2stringOpcionalSegunda mensagem da sequência.
message3stringOpcionalTerceira mensagem da sequência.
sessionIdstringOpcionalID da sessão WhatsApp.
delaystringOpcionalIntervalo entre envios.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/create Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "start": "valor", "message1": "valor", "message2": "valor", "message3": "valor", "sessionId": "valor", "delay": "valor" }

CampaignDelete

CampaignDelete
POST /v2/api/external/{ApiID}/campaign/delete/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/delete/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignDuplicate

CampaignDuplicate
POST /v2/api/external/{ApiID}/campaign/duplicate/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/duplicate/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignList

CampaignList
GET /v2/api/external/{ApiID}/campaign/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/campaign/list Authorization: Bearer SEU_TOKEN

CampaignPause

CampaignPause
POST /v2/api/external/{ApiID}/campaign/pause/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/pause/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignReport

CampaignReport
GET /v2/api/external/{ApiID}/campaign/report/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/campaign/report/{campaignId} Authorization: Bearer SEU_TOKEN

CampaignResume

CampaignResume
POST /v2/api/external/{ApiID}/campaign/resume/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/resume/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignSkip

CampaignSkip
POST /v2/api/external/{ApiID}/campaign/skip/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/skip/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignStart

CampaignStart
POST /v2/api/external/{ApiID}/campaign/start/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/start/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json

CampaignUpdate

CampaignUpdate
POST /v2/api/external/{ApiID}/campaign/update/{campaignId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
campaignIdstringObrigatórioID da campanha.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
startstringOpcionalData/hora de início.
message1stringOpcionalPrimeira mensagem da sequência.
message2stringOpcionalSegunda mensagem da sequência.
message3stringOpcionalTerceira mensagem da sequência.
sessionIdstringOpcionalID da sessão WhatsApp.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/campaign/update/{campaignId} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "start": "valor", "message1": "valor", "message2": "valor", "message3": "valor", "sessionId": "valor" }

ShowChannelInformation

ShowChannelInformation
POST /v2/api/external/{ApiID}/showChannel
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showChannel Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor" }

ShowChannelInformationById

ShowChannelInformationById
POST /v2/api/external/{ApiID}/showChannelById
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
idnumberOpcionalID único do registro.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showChannelById Authorization: Bearer SEU_TOKEN Content-Type: application/json { "id": 1 }

ListGroupsInfo

ListGroupsInfo
POST /v2/api/external/{ApiID}/listGroupInfo
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
listGroupsbooleanOpcionalListar grupos (true/false).
listParticipantsbooleanOpcionalListar participantes (true/false).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/listGroupInfo Authorization: Bearer SEU_TOKEN Content-Type: application/json { "listGroups": true, "listParticipants": true }

CreateSession

CreateSession
POST /v2/api/external/{ApiID}/createtSession
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
statusstringOpcionalStatus atual.
typestringOpcional
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createtSession Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "status": "valor", "type": "valor" }

DeleteSession

DeleteSession
POST /v2/api/external/{ApiID}/deleteSession
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdnumberOpcionalID do canal WhatsApp.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/deleteSession Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": 1 }

StartSession

StartSession
POST /v2/api/external/{ApiID}/startSession
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdnumberOpcionalID do canal WhatsApp.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/startSession Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": 1 }

ShowQrCode

ShowQrCode
POST /v2/api/external/{ApiID}/qrCodeSession
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdnumberOpcionalID do canal WhatsApp.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/qrCodeSession Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": 1 }

CreateContact

CreateContact
POST /v2/api/external/{ApiID}/createContact
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
numberstringOpcionalNúmero do contato (formato 5511999999999).
emailstringOpcionalEndereço de e-mail.
cpfstringOpcionalCPF do contato.
firstNamestringOpcionalPrimeiro nome.
lastNamestringOpcionalSobrenome.
businessNamestringOpcionalNome da empresa.
birthdayDatestringOpcionalData de aniversário.
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createContact Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "number": "valor", "email": "valor", "cpf": "valor", "firstName": "valor", "lastName": "valor", "businessName": "valor", "birthdayDate": "valor", "externalKey": "valor" }

ShowContact

ShowContact
POST /v2/api/external/{ApiID}/showcontact
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showcontact Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor" }

UpdateContact

UpdateContact
POST /v2/api/external/{ApiID}/updateContact
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
numberstringOpcionalNúmero do contato (formato 5511999999999).
emailstringOpcionalEndereço de e-mail.
cpfstringOpcionalCPF do contato.
firstNamestringOpcionalPrimeiro nome.
lastNamestringOpcionalSobrenome.
businessNamestringOpcionalNome da empresa.
birthdayDatestringOpcionalData de aniversário.
kanbannumberOpcionalID do kanban.
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateContact Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "number": "valor", "email": "valor", "cpf": "valor", "firstName": "valor", "lastName": "valor", "businessName": "valor", "birthdayDate": "valor", "kanban": 1, "externalKey": "valor" }

BlockContact

BlockContact
POST /v2/api/external/{ApiID}/blockContact
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
contactIdnumberOpcionalID do contato vinculado.
blockedbooleanOpcionalIndica se o contato está bloqueado.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/blockContact Authorization: Bearer SEU_TOKEN Content-Type: application/json { "contactId": 1, "blocked": true }

SearchContacts

SearchContacts
POST /v2/api/external/{ApiID}/contacts/search
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
searchParamstringOpcionalTermo de busca (opcional).
pagenumberOpcionalNúmero da página (paginação).
limitnumberOpcionalQuantidade de itens por página.
tagIdnumberOpcionalID da tag.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/contacts/search Authorization: Bearer SEU_TOKEN Content-Type: application/json { "searchParam": "valor", "page": 1, "limit": 1, "tagId": 1 }

UpdateContactKanban

UpdateContactKanban
POST /v2/api/external/{ApiID}/updateContactKanban
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
contactIdnumberOpcionalID do contato vinculado.
kanbannumberOpcionalID do kanban.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateContactKanban Authorization: Bearer SEU_TOKEN Content-Type: application/json { "contactId": 1, "kanban": 1 }

UpdateContactWallet

UpdateContactWallet
POST /v2/api/external/{ApiID}/updateContactWallet
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
contactIdnumberOpcionalID do contato vinculado.
walletIdnumberOpcionalID da wallet (carteira).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateContactWallet Authorization: Bearer SEU_TOKEN Content-Type: application/json { "contactId": 1, "walletId": 1 }

GetContactExtraInfo

GetContactExtraInfo
GET /v2/api/external/{ApiID}/getContactExtraInfo
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
contactIdintegerOpcionalID do contato
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/getContactExtraInfo Authorization: Bearer SEU_TOKEN

UpdateContactExtraInfo

UpdateContactExtraInfo
POST /v2/api/external/{ApiID}/updateContactExtraInfo
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
contactIdnumberOpcionalID do contato vinculado.
extraInfoarrayOpcionalLista de campos extras (nome/valor).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateContactExtraInfo Authorization: Bearer SEU_TOKEN Content-Type: application/json { "contactId": 1, "extraInfo": [] }

PipelineCreate

PipelineCreate
POST /v2/api/external/{ApiID}/pipeline/create
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
descriptionstringOpcionalDescrição detalhada.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/pipeline/create Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "description": "valor" }

PipelineDelete

PipelineDelete
POST /v2/api/external/{ApiID}/pipeline/delete/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/pipeline/delete/{id} Authorization: Bearer SEU_TOKEN

PipelineList

PipelineList
GET /v2/api/external/{ApiID}/pipeline/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/pipeline/list Authorization: Bearer SEU_TOKEN

PipelineShow

PipelineShow
GET /v2/api/external/{ApiID}/pipeline/show/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/pipeline/show/{id} Authorization: Bearer SEU_TOKEN

PipelineUpdate

PipelineUpdate
POST /v2/api/external/{ApiID}/pipeline/update/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/pipeline/update/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor" }

StageCreate

StageCreate
POST /v2/api/external/{ApiID}/stage/create
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
pipelineIdstringOpcionalID do pipeline.
ordernumberOpcionalOrdem de exibição.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/stage/create Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "pipelineId": "valor", "order": 1 }

StageDelete

StageDelete
POST /v2/api/external/{ApiID}/stage/delete/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/stage/delete/{id} Authorization: Bearer SEU_TOKEN

StageList

StageList
GET /v2/api/external/{ApiID}/stage/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
pipelineIdstringOpcionalID do pipeline.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/stage/list Authorization: Bearer SEU_TOKEN

StageShow

StageShow
GET /v2/api/external/{ApiID}/stage/show/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/stage/show/{id} Authorization: Bearer SEU_TOKEN

StageUpdate

StageUpdate
POST /v2/api/external/{ApiID}/stage/update/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/stage/update/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor" }

DashTicketsAndTimes

DashTicketsAndTimes
GET /v2/api/external/{ApiID}/dash/ticketsAndTimes
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsAndTimes Authorization: Bearer SEU_TOKEN

DashTicketsChannels

DashTicketsChannels
GET /v2/api/external/{ApiID}/dash/ticketsChannels
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsChannels Authorization: Bearer SEU_TOKEN

DashTicketsEvolution

DashTicketsEvolution
GET /v2/api/external/{ApiID}/dash/ticketsEvolution
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsEvolution Authorization: Bearer SEU_TOKEN

DashTicketsEvolutionByValue

DashTicketsEvolutionByValue
GET /v2/api/external/{ApiID}/dash/ticketsEvolutionByValue
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsEvolutionByValue Authorization: Bearer SEU_TOKEN

DashTicketsEvolutionChannelsName

DashTicketsEvolutionChannelsName
GET /v2/api/external/{ApiID}/dash/ticketsEvolutionChannelsName
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsEvolutionChannelsName Authorization: Bearer SEU_TOKEN

DashTicketsPerUser

DashTicketsPerUser
GET /v2/api/external/{ApiID}/dash/ticketsPerUser
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsPerUser Authorization: Bearer SEU_TOKEN

DashTicketsQueue

DashTicketsQueue
GET /v2/api/external/{ApiID}/dash/ticketsQueue
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsQueue Authorization: Bearer SEU_TOKEN

DashTicketsReasons

DashTicketsReasons
GET /v2/api/external/{ApiID}/dash/ticketsReasons
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsReasons Authorization: Bearer SEU_TOKEN

DashTicketsStatus

DashTicketsStatus
GET /v2/api/external/{ApiID}/dash/ticketsStatus
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsStatus Authorization: Bearer SEU_TOKEN

DashTicketsUser

DashTicketsUser
GET /v2/api/external/{ApiID}/dash/ticketsUser
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
startDatestringOpcionalData inicial do filtro (YYYY-MM-DD).
endDatestringOpcionalData final do filtro (YYYY-MM-DD).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/dash/ticketsUser Authorization: Bearer SEU_TOKEN

BulkDispatchIncrementProgress

BulkDispatchIncrementProgress
POST /v2/api/external/{ApiID}/bulkDispatch/incrementProgress/{dispatchId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
dispatchIdstringObrigatórioID do disparo.
Corpo da requisição
CampoTipoObrigatórioDescrição
successbooleanOpcionalIndica sucesso do envio.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/bulkDispatch/incrementProgress/{dispatchId} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "success": true }

BulkDispatchList

BulkDispatchList
GET /v2/api/external/{ApiID}/bulkDispatch/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/bulkDispatch/list Authorization: Bearer SEU_TOKEN

BulkDispatchShow

BulkDispatchShow
GET /v2/api/external/{ApiID}/bulkDispatch/show/{dispatchId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
dispatchIdstringObrigatórioID do disparo.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/bulkDispatch/show/{dispatchId} Authorization: Bearer SEU_TOKEN

BulkDispatchUpdate

BulkDispatchUpdate
POST /v2/api/external/{ApiID}/bulkDispatch/update/{dispatchId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
dispatchIdstringObrigatórioID do disparo.
Corpo da requisição
CampoTipoObrigatórioDescrição
statusstringOpcionalStatus atual.
cancellationReasonstringOpcionalMotivo do cancelamento.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/bulkDispatch/update/{dispatchId} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "status": "valor", "cancellationReason": "valor" }

BulkFastMessage

BulkFastMessage
POST /v2/api/external/{ApiID}/bulkFastMessage
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
whatsappTypestringOpcional
arrayNumbersarrayOpcionalArray de números de destinatários.
messagestringOpcionalTexto da mensagem.
minnumberOpcionalIntervalo mínimo entre envios (segundos).
maxnumberOpcionalIntervalo máximo entre envios (segundos).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/bulkFastMessage Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "whatsappType": "valor", "arrayNumbers": [], "message": "valor", "min": 1, "max": 1 }

BulkIndividual

BulkIndividual
POST /v2/api/external/{ApiID}/bulkIndividual
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
numberstringOpcionalNúmero do contato (formato 5511999999999).
messagestringOpcionalTexto da mensagem.
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/bulkIndividual Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "number": "valor", "message": "valor", "externalKey": "valor" }

BulkSendMessage

BulkSendMessage
POST /v2/api/external/{ApiID}/bulkSendMessage
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
arrayNumbersarrayOpcionalArray de números de destinatários.
messagestringOpcionalTexto da mensagem.
minnumberOpcionalIntervalo mínimo entre envios (segundos).
maxnumberOpcionalIntervalo máximo entre envios (segundos).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/bulkSendMessage Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "arrayNumbers": [], "message": "valor", "min": 1, "max": 1 }

BulkSendMessageWithVariable

BulkSendMessageWithVariable
POST /v2/api/external/{ApiID}/bulkSendMessageWithVariable
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
messagestringOpcionalTexto da mensagem.
dataInputstringOpcionalDados de entrada (JSON ou texto).
minnumberOpcionalIntervalo mínimo entre envios (segundos).
maxnumberOpcionalIntervalo máximo entre envios (segundos).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/bulkSendMessageWithVariable Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "message": "valor", "dataInput": "valor", "min": 1, "max": 1 }

GalleryDelete

GalleryDelete
POST /v2/api/external/{ApiID}/gallery/delete/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/gallery/delete/{id} Authorization: Bearer SEU_TOKEN

GalleryList

GalleryList
GET /v2/api/external/{ApiID}/gallery/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageNumberintegerOpcionalNúmero da página (paginação).
fileTypestringOpcionalTipo do arquivo (image, video, audio, document).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/gallery/list Authorization: Bearer SEU_TOKEN

GalleryUpload

GalleryUpload
POST /v2/api/external/{ApiID}/gallery/upload
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
descriptionstringOpcionalDescrição detalhada.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/gallery/upload Authorization: Bearer SEU_TOKEN Content-Type: application/json { "description": "valor" }

GroupAddParticipant

GroupAddParticipant
POST /v2/api/external/{ApiID}/group/addParticipant
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
participantsarrayOpcionalLista de números dos participantes.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/addParticipant Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "participants": [] }

GroupChangeDescription

GroupChangeDescription
POST /v2/api/external/{ApiID}/group/changeDescription
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
descriptionstringOpcionalDescrição detalhada.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/changeDescription Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "description": "valor" }

GroupChangePicture

GroupChangePicture
POST /v2/api/external/{ApiID}/group/changePicture
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
picturestringOpcionalURL ou base64 da imagem.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/changePicture Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "picture": "valor" }

GroupChangeTitle

GroupChangeTitle
POST /v2/api/external/{ApiID}/group/changeTitle
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
titlestringOpcionalTítulo.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/changeTitle Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "title": "valor" }

GroupCreate

GroupCreate
POST /v2/api/external/{ApiID}/group/create
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
titlesarrayOpcionalLista de títulos.
numberstringOpcionalNúmero do contato (formato 5511999999999).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/create Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "titles": [], "number": "valor" }

GroupDemote

GroupDemote
POST /v2/api/external/{ApiID}/group/demote
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
participantsarrayOpcionalLista de números dos participantes.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/demote Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "participants": [] }

GroupList

GroupList
POST /v2/api/external/{ApiID}/group/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/list Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor" }

GroupListParticipants

GroupListParticipants
POST /v2/api/external/{ApiID}/group/listParticipants
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/listParticipants Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [] }

GroupPromote

GroupPromote
POST /v2/api/external/{ApiID}/group/promote
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
participantsarrayOpcionalLista de números dos participantes.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/promote Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "participants": [] }

GroupRemoveParticipant

GroupRemoveParticipant
POST /v2/api/external/{ApiID}/group/removeParticipant
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
participantsarrayOpcionalLista de números dos participantes.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/removeParticipant Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "participants": [] }

GroupSetAdminsOnly

GroupSetAdminsOnly
POST /v2/api/external/{ApiID}/group/setAdminsOnly
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdsarrayOpcionalLista de IDs de grupos.
adminsOnlybooleanOpcionalApenas admins podem enviar (true/false).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/setAdminsOnly Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupIds": [], "adminsOnly": true }

GroupShowById

GroupShowById
POST /v2/api/external/{ApiID}/group/showById
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
whatsappIdstringOpcionalID do canal WhatsApp.
groupIdstringOpcionalID do grupo.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group/showById Authorization: Bearer SEU_TOKEN Content-Type: application/json { "whatsappId": "valor", "groupId": "valor" }

CreateKanban

CreateKanban
POST /v2/api/external/{ApiID}/createKanban
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createKanban Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor" }

CreateQueueData

CreateQueueData
POST /v2/api/external/{ApiID}/createQueueData
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
queuestringOpcionalNome da fila.
isActivebooleanOpcionalIndica se está ativo (true/false).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createQueueData Authorization: Bearer SEU_TOKEN Content-Type: application/json { "queue": "valor", "isActive": true }

CreateReason

CreateReason
POST /v2/api/external/{ApiID}/createReason
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createReason Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor" }

CreateTag

CreateTag
POST /v2/api/external/{ApiID}/createTag
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
tagstringOpcionalID ou nome da tag.
colorstringOpcionalCor da tag (hex).
isActivebooleanOpcionalIndica se está ativo (true/false).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createTag Authorization: Bearer SEU_TOKEN Content-Type: application/json { "tag": "valor", "color": "valor", "isActive": true }

DeleteKanban

DeleteKanban
POST /v2/api/external/{ApiID}/deleteKanban/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/deleteKanban/{id} Authorization: Bearer SEU_TOKEN

DeleteQueueData

DeleteQueueData
POST /v2/api/external/{ApiID}/deleteQueueData/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/deleteQueueData/{id} Authorization: Bearer SEU_TOKEN

DeleteReason

DeleteReason
POST /v2/api/external/{ApiID}/deleteReason/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/deleteReason/{id} Authorization: Bearer SEU_TOKEN

DeleteTag

DeleteTag
POST /v2/api/external/{ApiID}/deleteTag/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/deleteTag/{id} Authorization: Bearer SEU_TOKEN

ListKanban

ListKanban
GET /v2/api/external/{ApiID}/listKanban
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listKanban Authorization: Bearer SEU_TOKEN

ListReasons

ListReasons
GET /v2/api/external/{ApiID}/listReasons
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listReasons Authorization: Bearer SEU_TOKEN

UpdateKanban

UpdateKanban
POST /v2/api/external/{ApiID}/updateKanban/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateKanban/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor" }

UpdateQueueData

UpdateQueueData
POST /v2/api/external/{ApiID}/updateQueueData/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
queuestringOpcionalNome da fila.
isActivebooleanOpcionalIndica se está ativo (true/false).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateQueueData/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "queue": "valor", "isActive": true }

UpdateReason

UpdateReason
POST /v2/api/external/{ApiID}/updateReason/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateReason/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor" }

UpdateTagData

UpdateTagData
POST /v2/api/external/{ApiID}/updateTagData/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
tagstringOpcionalID ou nome da tag.
colorstringOpcionalCor da tag (hex).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateTagData/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "tag": "valor", "color": "valor" }

ListAutoReplies

ListAutoReplies
GET /v2/api/external/{ApiID}/listAutoReplies
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listAutoReplies Authorization: Bearer SEU_TOKEN

ListChatFlows

ListChatFlows
GET /v2/api/external/{ApiID}/listChatFlows
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listChatFlows Authorization: Bearer SEU_TOKEN

ListFastReplies

ListFastReplies
GET /v2/api/external/{ApiID}/listFastReplies
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listFastReplies Authorization: Bearer SEU_TOKEN

ListChannels

ListChannels
GET /v2/api/external/{ApiID}/listChannels
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listChannels Authorization: Bearer SEU_TOKEN

ListSessions

ListSessions
GET /v2/api/external/{ApiID}/listSessions
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listSessions Authorization: Bearer SEU_TOKEN

ListTickets

ListTickets
GET /v2/api/external/{ApiID}/listTickets
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageNumberintegerOpcionalNúmero da página
statusstringOpcionalStatus do ticket (open, pending, closed)
searchParamstringOpcionalParâmetro de busca (opcional)
queuesIdsstringOpcionalIDs das filas (opcional)
whatsappIdsstringOpcionalIDs dos canais (opcional)
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listTickets Authorization: Bearer SEU_TOKEN

ListOpportunities

ListOpportunities
GET /v2/api/external/{ApiID}/listOpportunities
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página
limitintegerOpcionalLimite de resultados por página
statusstringOpcionalStatus da oportunidade (opcional)
pipelineIdstringOpcionalID do pipeline (opcional)
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listOpportunities Authorization: Bearer SEU_TOKEN

ListContacts

ListContacts
GET /v2/api/external/{ApiID}/listContacts
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageNumberintegerOpcionalNúmero da página
searchParamstringOpcionalParâmetro de busca (opcional)
walletIdstringOpcionalID da wallet (opcional)
tagIdstringOpcionalID da tag (opcional)
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listContacts Authorization: Bearer SEU_TOKEN

ListTags

ListTags
GET /v2/api/external/{ApiID}/listTags
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
isActivebooleanOpcionalFiltrar por tags ativas (true/false)
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listTags Authorization: Bearer SEU_TOKEN

ListQueues

ListQueues
GET /v2/api/external/{ApiID}/listQueues
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listQueues Authorization: Bearer SEU_TOKEN

CallLogList

CallLogList
GET /v2/api/external/{ApiID}/callLog/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/callLog/list Authorization: Bearer SEU_TOKEN

CallLogShow

CallLogShow
GET /v2/api/external/{ApiID}/callLog/show/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/callLog/show/{id} Authorization: Bearer SEU_TOKEN

WavoipCallList

WavoipCallList
GET /v2/api/external/{ApiID}/wavoip/calls
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/wavoip/calls Authorization: Bearer SEU_TOKEN

WavoipCallShow

WavoipCallShow
GET /v2/api/external/{ApiID}/wavoip/calls/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/wavoip/calls/{id} Authorization: Bearer SEU_TOKEN

SearchMessages

SearchMessages
GET /v2/api/external/{ApiID}/searchMessages
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
ticketIdstringOpcionalID do ticket.
searchParamstringOpcionalTermo de busca (opcional).
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/searchMessages Authorization: Bearer SEU_TOKEN

SendLocation

SendLocation
POST /v2/api/external/{ApiID}/sendLocation
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
latitudenumberOpcionalLatitude (coordenada).
longitudenumberOpcionalLongitude (coordenada).
namestringOpcionalNome identificador.
addressstringOpcionalEndereço.
ticketIdstringOpcionalID do ticket.
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/sendLocation Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "latitude": 1, "longitude": 1, "name": "valor", "address": "valor", "ticketId": "valor", "externalKey": "valor" }

SendVcard

SendVcard
POST /v2/api/external/{ApiID}/sendVcard
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
contactarrayOpcionalLista de contatos a serem enviados como vCard.
ticketIdstringOpcionalID do ticket.
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/sendVcard Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "contact": [], "ticketId": "valor", "externalKey": "valor" }

SendGroupMessageAPIText

SendGroupMessageAPIText
POST /v2/api/external/{ApiID}/group
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
bodystringOpcionalCorpo/texto da mensagem.
numberstringOpcionalNúmero do contato (formato 5511999999999).
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/group Authorization: Bearer SEU_TOKEN Content-Type: application/json { "body": "valor", "number": "valor", "externalKey": "valor", "isClosed": true }

SendMessageAPIFileURLGroup

SendMessageAPIFileURLGroup
POST /v2/api/external/{ApiID}/groupMediaUrl
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
mediaUrlstringOpcionalURL da mídia a ser enviada.
bodystringOpcionalCorpo/texto da mensagem.
numberstringOpcionalNúmero do contato (formato 5511999999999).
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/groupMediaUrl Authorization: Bearer SEU_TOKEN Content-Type: application/json { "mediaUrl": "valor", "body": "valor", "number": "valor", "externalKey": "valor", "isClosed": true }

SendMessageParams

SendMessageParams
GET /v2/api/external/{ApiID}/params/
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
bodystringOpcionalTexto da mensagem que será enviada
numberintegerOpcionalNúmero do WhatsApp do destinatário (formato: 5511999999999)
externalKeystringOpcionalChave única do sistema para identificação (valor gerado do seu lado para controle do envio)
bearertokenstringOpcionalToken de autenticação
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/params/ Authorization: Bearer SEU_TOKEN

SendMessageAPIText

SendMessageAPIText
POST /v2/api/external/{ApiID}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
bodystringOpcionalCorpo/texto da mensagem.
numberstringOpcionalNúmero do contato (formato 5511999999999).
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "body": "valor", "number": "valor", "externalKey": "valor", "isClosed": true }

SendMessageAPIFileURL

SendMessageAPIFileURL
POST /v2/api/external/{ApiID}/url
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
mediaUrlstringOpcionalURL da mídia a ser enviada.
bodystringOpcionalCorpo/texto da mensagem.
numberstringOpcionalNúmero do contato (formato 5511999999999).
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/url Authorization: Bearer SEU_TOKEN Content-Type: application/json { "mediaUrl": "valor", "body": "valor", "number": "valor", "externalKey": "valor", "isClosed": true }

SendMessageAPIVoice

SendMessageAPIVoice
POST /v2/api/external/{ApiID}/voice
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
audiostringOpcionalURL ou base64 do áudio.
numberstringOpcionalNúmero do contato (formato 5511999999999).
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/voice Authorization: Bearer SEU_TOKEN Content-Type: application/json { "audio": "valor", "number": "valor", "externalKey": "valor", "isClosed": true }

SendMessageAPITextBase64

SendMessageAPITextBase64
POST /v2/api/external/{ApiID}/base64
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
bodystringOpcionalCorpo/texto da mensagem.
numberstringOpcionalNúmero do contato (formato 5511999999999).
base64DatastringOpcionalConteúdo do arquivo em base64.
mimeTypestringOpcionalTipo MIME do arquivo.
fileNamestringOpcionalNome do arquivo.
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/base64 Authorization: Bearer SEU_TOKEN Content-Type: application/json { "body": "valor", "number": "valor", "base64Data": "valor", "mimeType": "valor", "fileName": "valor", "isClosed": true }
🧩

Seção em construção

Esta área da API está reservada para futura documentação de modelos de dados.
Em caso de dúvidas, fale com nossa equipe técnica.

CreateOpportunity

CreateOpportunity
POST /v2/api/external/{ApiID}/createOpportunity
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
contactNamestringOpcionalNome do contato.
emailstringOpcionalEndereço de e-mail.
namestringOpcionalNome identificador.
valuenumberOpcionalValor monetário.
statusstringOpcionalStatus atual.
pipelineIdnumberOpcionalID do pipeline.
stageIdnumberOpcionalID da etapa do pipeline.
responsibleIdnumberOpcionalID do responsável.
closingForecaststringOpcionalPrevisão de fechamento.
descriptionstringOpcionalDescrição detalhada.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createOpportunity Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "contactName": "valor", "email": "valor", "name": "valor", "value": 1, "status": "valor", "pipelineId": 1, "stageId": 1, "responsibleId": 1, "closingForecast": "valor", "description": "valor" }

DeleteOpportunity

DeleteOpportunity
POST /v2/api/external/{ApiID}/deleteOpportunity
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
opportunityIdnumberOpcionalID da oportunidade.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/deleteOpportunity Authorization: Bearer SEU_TOKEN Content-Type: application/json { "opportunityId": 1 }

UpdateOpportunity

UpdateOpportunity
POST /v2/api/external/{ApiID}/updateOpportunity
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
opportunityIdnumberOpcionalID da oportunidade.
namestringOpcionalNome identificador.
valuenumberOpcionalValor monetário.
statusstringOpcionalStatus atual.
pipelineIdnumberOpcionalID do pipeline.
stageIdnumberOpcionalID da etapa do pipeline.
responsibleIdnumberOpcionalID do responsável.
closingForecaststringOpcionalPrevisão de fechamento.
descriptionstringOpcionalDescrição detalhada.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateOpportunity Authorization: Bearer SEU_TOKEN Content-Type: application/json { "opportunityId": 1, "name": "valor", "value": 1, "status": "valor", "pipelineId": 1, "stageId": 1, "responsibleId": 1, "closingForecast": "valor", "description": "valor" }

SendTemplateWaba

SendTemplateWaba
POST /v2/api/external/{ApiID}/template
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
templateDataobjectOpcionalObjeto com dados do template oficial WABA.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/template Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "isClosed": true, "templateData": {} }

SendTemplateWabaBody

SendTemplateWabaBody
POST /v2/api/external/{ApiID}/templateBody
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
templateDataobjectOpcionalObjeto com dados do template oficial WABA.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/templateBody Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "isClosed": true, "templateData": {} }

SendTemplateWabaMarketing

SendTemplateWabaMarketing
POST /v2/api/external/{ApiID}/templateMarketingBody
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
isClosedbooleanOpcionalDefine se o ticket será fechado após o envio.
templateDataobjectOpcionalObjeto com dados do template oficial WABA.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/templateMarketingBody Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "isClosed": true, "templateData": {} }

CreateApi

CreateApi
POST /tenantCreateApi
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
sessionIdnumberOpcionalID da sessão WhatsApp.
urlServiceStatusstringOpcionalURL para receber status do serviço.
urlMessageStatusstringOpcionalURL para receber status das mensagens.
userIdnumberOpcionalID do usuário.
authTokenstringOpcionalToken de autenticação.
tenantnumberOpcionalID do tenant.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /tenantCreateApi Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "sessionId": 1, "urlServiceStatus": "valor", "urlMessageStatus": "valor", "userId": 1, "authToken": "valor", "tenant": 1 }

DeleteApi

DeleteApi
POST /tenantDeleteApi
Corpo da requisição
CampoTipoObrigatórioDescrição
sessionIdnumberOpcionalID da sessão WhatsApp.
userIdnumberOpcionalID do usuário.
tenantnumberOpcionalID do tenant.
apiIdstringOpcionalID da API.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /tenantDeleteApi Authorization: Bearer SEU_TOKEN Content-Type: application/json { "sessionId": 1, "userId": 1, "tenant": 1, "apiId": "valor" }

StoreTenant

StoreTenant
POST /tenantApiStoreTenant
Corpo da requisição
CampoTipoObrigatórioDescrição
statusstringOpcionalStatus atual.
namestringOpcionalNome identificador.
maxUsersnumberOpcionalNúmero máximo de usuários.
maxConnectionsnumberOpcionalNúmero máximo de conexões.
acceptTermsbooleanOpcionalAceite dos termos de uso.
emailstringOpcionalEndereço de e-mail.
passwordstringOpcionalSenha do usuário.
userNamestringOpcionalNome do usuário.
profilestringOpcionalPerfil de acesso do usuário.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /tenantApiStoreTenant Authorization: Bearer SEU_TOKEN Content-Type: application/json { "status": "valor", "name": "valor", "maxUsers": 1, "maxConnections": 1, "acceptTerms": true, "email": "valor", "password": "valor", "userName": "valor", "profile": "valor" }

CreateSessionTenant

CreateSessionTenant
POST /tenantApiCreateSession
Corpo da requisição
CampoTipoObrigatórioDescrição
tenantnumberOpcionalID do tenant.
namestringOpcionalNome identificador.
statusstringOpcionalStatus atual.
typestringOpcional
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /tenantApiCreateSession Authorization: Bearer SEU_TOKEN Content-Type: application/json { "tenant": 1, "name": "valor", "status": "valor", "type": "valor" }

ShowTenant

ShowTenant
POST /tenantApiShowTenant
Corpo da requisição
CampoTipoObrigatórioDescrição
idnumberOpcionalID único do registro.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /tenantApiShowTenant Authorization: Bearer SEU_TOKEN Content-Type: application/json { "id": 1 }

UpdateTenant

UpdateTenant
POST /tenantApiUpdateTenant
Corpo da requisição
CampoTipoObrigatórioDescrição
identitystringOpcionalIdentificador único.
statusstringOpcionalStatus atual.
maxUsersnumberOpcionalNúmero máximo de usuários.
maxConnectionsnumberOpcionalNúmero máximo de conexões.
paymentGatewaystringOpcionalGateway de pagamento.
supportChatEnabledstringOpcionalIndica se o chat de suporte está habilitado.
menuVisibilityarrayOpcionalItens de menu visíveis.
allowedChannelsarrayOpcionalCanais permitidos.
channelConnectionLimitsobjectOpcionalLimites de conexões por canal.
oauthEnabledbooleanOpcionalIndica se OAuth está habilitado.
oauthProxyUrlstringOpcionalURL do proxy OAuth.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /tenantApiUpdateTenant Authorization: Bearer SEU_TOKEN Content-Type: application/json { "identity": "valor", "status": "valor", "maxUsers": 1, "maxConnections": 1, "paymentGateway": "valor", "supportChatEnabled": "valor", "menuVisibility": [], "allowedChannels": [], "channelConnectionLimits": {}, "oauthEnabled": true, "oauthProxyUrl": "valor" }

ListTenants

ListTenants
GET /tenantApiListTenants
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /tenantApiListTenants Authorization: Bearer SEU_TOKEN

EndTicketPause

EndTicketPause
POST /v2/api/external/{ApiID}/ticket/pause/end/{ticketId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
ticketIdstringObrigatórioID do ticket.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/ticket/pause/end/{ticketId} Authorization: Bearer SEU_TOKEN

ListTicketEvaluations

ListTicketEvaluations
GET /v2/api/external/{ApiID}/listTicketEvaluations
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageintegerOpcionalNúmero da página (paginação).
limitintegerOpcionalQuantidade de itens por página.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listTicketEvaluations Authorization: Bearer SEU_TOKEN

ListTicketPauseLogs

ListTicketPauseLogs
GET /v2/api/external/{ApiID}/ticket/pause/logs/{ticketId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
ticketIdstringObrigatórioID do ticket.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/ticket/pause/logs/{ticketId} Authorization: Bearer SEU_TOKEN

ShowTicketById

ShowTicketById
POST /v2/api/external/{ApiID}/showTicketById
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdstringOpcionalID do ticket.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showTicketById Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": "valor" }

StartTicketPause

StartTicketPause
POST /v2/api/external/{ApiID}/ticket/pause/start/{ticketId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
ticketIdstringObrigatórioID do ticket.
Corpo da requisição
CampoTipoObrigatórioDescrição
pauseReasonstringOpcionalMotivo da pausa.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/ticket/pause/start/{ticketId} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "pauseReason": "valor" }

TicketShareCreate

TicketShareCreate
POST /v2/api/external/{ApiID}/ticket/share
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdstringOpcionalID do ticket.
inviteUrlstringOpcionalURL de convite.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/ticket/share Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": "valor", "inviteUrl": "valor" }

TicketShareShow

TicketShareShow
GET /v2/api/external/{ApiID}/ticket/share/{ticketId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
ticketIdstringObrigatórioID do ticket.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/ticket/share/{ticketId} Authorization: Bearer SEU_TOKEN

AddTag

AddTag
POST /v2/api/external/{ApiID}/addTag
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdnumberOpcionalID do ticket.
tagIdnumberOpcionalID da tag.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/addTag Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": 1, "tagId": 1 }

CreateNotes

CreateNotes
POST /v2/api/external/{ApiID}/createNotes
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
notesstringOpcionalAnotações.
ticketIdnumberOpcionalID do ticket.
userIdnumberOpcionalID do usuário.
idFrontstringOpcionalIdentificador front-end.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createNotes Authorization: Bearer SEU_TOKEN Content-Type: application/json { "notes": "valor", "ticketId": 1, "userId": 1, "idFront": "valor" }

CreateTicketWebmail

CreateTicketWebmail
POST /v2/api/external/{ApiID}/createTicket
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
bodystringOpcionalCorpo/texto da mensagem.
emailstringOpcionalEndereço de e-mail.
channelIdnumberOpcionalID do canal.
externalKeystringOpcionalChave externa do sistema (controle do seu lado).
userIdnumberOpcionalID do usuário.
statusstringOpcionalStatus atual.
namestringOpcionalNome identificador.
firstNamestringOpcionalPrimeiro nome.
lastNamestringOpcionalSobrenome.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createTicket Authorization: Bearer SEU_TOKEN Content-Type: application/json { "body": "valor", "email": "valor", "channelId": 1, "externalKey": "valor", "userId": 1, "status": "valor", "name": "valor", "firstName": "valor", "lastName": "valor" }

ListNotes

ListNotes
GET /v2/api/external/{ApiID}/listNotes
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
ticketIdintegerOpcionalID do ticket
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listNotes Authorization: Bearer SEU_TOKEN

RemoveTag

RemoveTag
POST /v2/api/external/{ApiID}/removeTag
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdnumberOpcionalID do ticket.
tagIdnumberOpcionalID da tag.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/removeTag Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": 1, "tagId": 1 }

SendPresence

SendPresence
POST /v2/api/external/{ApiID}/sendPresence
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdnumberOpcionalID do ticket.
statestringOpcionalEstado atual (typing, recording, etc.).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/sendPresence Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": 1, "state": "valor" }

SetQueue

SetQueue
POST /v2/api/external/{ApiID}/updatequeue
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdnumberOpcionalID do ticket.
queueIdnumberOpcionalID da fila de atendimento.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updatequeue Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": 1, "queueId": 1 }

SetTag

SetTag
POST /v2/api/external/{ApiID}/updatetag
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdnumberOpcionalID do ticket.
tagnumberOpcionalID ou nome da tag.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updatetag Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": 1, "tag": 1 }

SetTicketInfo

SetTicketInfo
POST /v2/api/external/{ApiID}/updateticketinfo
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdnumberOpcionalID do ticket.
userIdnumberOpcionalID do usuário.
statusstringOpcionalStatus atual.
queueIdstringOpcionalID da fila de atendimento.
typebotStatusbooleanOpcionalHabilita Typebot.
chatgptStatusbooleanOpcionalHabilita integração com ChatGPT.
dialogflowStatusbooleanOpcionalHabilita Dialogflow.
difyStatusbooleanOpcionalHabilita Dify.
n8nStatusbooleanOpcionalHabilita N8N.
chatFlowIdstringOpcionalID do fluxo de chat.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateticketinfo Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": 1, "userId": 1, "status": "valor", "queueId": "valor", "typebotStatus": true, "chatgptStatus": true, "dialogflowStatus": true, "difyStatus": true, "n8nStatus": true, "chatFlowId": "valor" }

ShowAllMessages

ShowAllMessages
POST /v2/api/external/{ApiID}/showAllMessages
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketstringOpcionalID ou número do ticket.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showAllMessages Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticket": "valor" }

ShowAllTicketInformation

ShowAllTicketInformation
POST /v2/api/external/{ApiID}/showallticket
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showallticket Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor" }

ShowTicketInformation

ShowTicketInformation
POST /v2/api/external/{ApiID}/showticket
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showticket Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor" }

ShowTicketInformationChatBot

ShowTicketInformationChatBot
POST /v2/api/external/{ApiID}/showticketchatbot
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/showticketchatbot Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor" }

UpdateNote

UpdateNote
POST /v2/api/external/{ApiID}/updateNote
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
noteIdnumberOpcionalID da nota.
notesstringOpcionalAnotações.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateNote Authorization: Bearer SEU_TOKEN Content-Type: application/json { "noteId": 1, "notes": "valor" }

UpdateTicketChannel

UpdateTicketChannel
POST /v2/api/external/{ApiID}/updateTicketChannel
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
ticketIdnumberOpcionalID do ticket.
whatsappIdnumberOpcionalID do canal WhatsApp.
channelstringOpcionalTipo de canal.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateTicketChannel Authorization: Bearer SEU_TOKEN Content-Type: application/json { "ticketId": 1, "whatsappId": 1, "channel": "valor" }

TodoCreate

TodoCreate
POST /v2/api/external/{ApiID}/todo/create
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
namestringOpcionalNome identificador.
descriptionstringOpcionalDescrição detalhada.
ownerstringOpcionalResponsável pela tarefa.
ownerIdstringOpcionalID do responsável.
statusstringOpcionalStatus atual.
prioritystringOpcionalPrioridade (alta, média, baixa).
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/todo/create Authorization: Bearer SEU_TOKEN Content-Type: application/json { "name": "valor", "description": "valor", "owner": "valor", "ownerId": "valor", "status": "valor", "priority": "valor" }

TodoDelete

TodoDelete
POST /v2/api/external/{ApiID}/todo/delete/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição

Não requer corpo. A requisição executa a ação diretamente.

Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/todo/delete/{id} Authorization: Bearer SEU_TOKEN

TodoList

TodoList
GET /v2/api/external/{ApiID}/todo/list
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/todo/list Authorization: Bearer SEU_TOKEN

TodoLogs

TodoLogs
GET /v2/api/external/{ApiID}/todo/logs/{userId}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
userIdstringObrigatórioID do usuário.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/todo/logs/{userId} Authorization: Bearer SEU_TOKEN

TodoUpdate

TodoUpdate
POST /v2/api/external/{ApiID}/todo/update/{id}
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
idstringObrigatórioID único do registro.
Corpo da requisição
CampoTipoObrigatórioDescrição
statusstringOpcionalStatus atual.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/todo/update/{id} Authorization: Bearer SEU_TOKEN Content-Type: application/json { "status": "valor" }

CreateUser

CreateUser
POST /v2/api/external/{ApiID}/createUser
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
emailstringOpcionalEndereço de e-mail.
passwordstringOpcionalSenha do usuário.
namestringOpcionalNome identificador.
profilestringOpcionalPerfil de acesso do usuário.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/createUser Authorization: Bearer SEU_TOKEN Content-Type: application/json { "email": "valor", "password": "valor", "name": "valor", "profile": "valor" }

GetUserStatus

GetUserStatus
GET /v2/api/external/{ApiID}/getUserStatus
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
userIdintegerOpcionalID do usuário
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/getUserStatus Authorization: Bearer SEU_TOKEN

ListUsers

ListUsers
GET /v2/api/external/{ApiID}/listUsers
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Parâmetros de consulta (query)
NomeTipoObrigatórioDescrição
pageNumberintegerOpcionalNúmero da página
searchParamstringOpcionalParâmetro de busca (opcional)
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
GET /v2/api/external/{ApiID}/listUsers Authorization: Bearer SEU_TOKEN

UpdateUser

UpdateUser
POST /v2/api/external/{ApiID}/updateUser
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
userIdnumberOpcionalID do usuário.
namestringOpcionalNome identificador.
emailstringOpcionalEndereço de e-mail.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/updateUser Authorization: Bearer SEU_TOKEN Content-Type: application/json { "userId": 1, "name": "valor", "email": "valor" }

SendButtonWABA

SendButtonWABA
POST /v2/api/external/{ApiID}/sendButtonWABA
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
messagestringOpcionalTexto da mensagem.
button1stringOpcionalTexto do primeiro botão.
button2stringOpcionalTexto do segundo botão.
button3stringOpcionalTexto do terceiro botão.
ticketIdnumberOpcionalID do ticket.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/sendButtonWABA Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "message": "valor", "button1": "valor", "button2": "valor", "button3": "valor", "ticketId": 1 }

SendListWABA

SendListWABA
POST /v2/api/external/{ApiID}/sendListWABA
Parâmetros de URL
NomeTipoObrigatórioDescrição
ApiIDstringObrigatórioIdentificador da API da sua conta.
Corpo da requisição
CampoTipoObrigatórioDescrição
numberstringOpcionalNúmero do contato (formato 5511999999999).
headerstringOpcionalCabeçalho da mensagem interativa.
bodystringOpcionalCorpo/texto da mensagem.
footerstringOpcionalRodapé da mensagem interativa.
button_textstringOpcionalTexto do botão principal.
sectionsarrayOpcionalSeções da lista interativa.
ticketIdnumberOpcionalID do ticket.
Resposta
200Requisição processada com sucesso.
Exemplo
Requisição
POST /v2/api/external/{ApiID}/sendListWABA Authorization: Bearer SEU_TOKEN Content-Type: application/json { "number": "valor", "header": "valor", "body": "valor", "footer": "valor", "button_text": "valor", "sections": [], "ticketId": 1 }