AppointmentCreate

Cria appointment.

Corpo da requisição

{
  "title": "Reunião de Vendas",
  "description": "Reunião sobre proposta comercial",
  "contactId": "{{contactId}}",
  "contactName": "João Silva",
  "contactPhone": "5511999999999",
  "whatsappId": "{{whatsappId}}",
  "startAt": "2026-04-15T14:00:00.000Z",
  "endAt": "2026-04-15T15:00:00.000Z",
  "status": "pending",
  "notes": "Levar proposta impressa"
}

AppointmentDelete

Remove appointment.

Corpo da requisição

{}

AppointmentList

Lista appointment.

Parâmetros de query

AppointmentShow

Exibe appointment.

AppointmentUpdate

Atualiza appointment.

Corpo da requisição

{
  "title": "Reunião de Vendas (atualizada)",
  "description": "Descrição atualizada",
  "contactId": "{{contactId}}",
  "contactName": "João Silva",
  "contactPhone": "5511999999999",
  "whatsappId": "{{whatsappId}}",
  "startAt": "2026-04-15T15:00:00.000Z",
  "endAt": "2026-04-15T16:00:00.000Z",
  "status": "confirmed",
  "notes": "Cliente confirmou presença"
}

ScheduleReminderCreate

Cria schedule reminder.

Corpo da requisição

{
  "name": "Lembrete 24h antes",
  "description": "Envia mensagem ao contato 24h antes do agendamento",
  "hoursBeforeEvent": 24,
  "messageType": "message",
  "messageContent": "Olá {{nome}}, lembrete da sua reunião amanhã!",
  "whatsappId": "{{whatsappId}}",
  "active": true
}

ScheduleReminderDelete

Remove schedule reminder.

Corpo da requisição

{}

ScheduleReminderList

Lista schedule reminder.

ScheduleReminderToggle

Alterna schedule reminder.

Corpo da requisição

{}

ScheduleReminderUpdate

Atualiza schedule reminder.

Corpo da requisição

{
  "name": "Lembrete 48h antes",
  "description": "Envia mensagem 48h antes do evento",
  "hoursBeforeEvent": 48,
  "messageType": "message",
  "messageContent": "Olá {{nome}}, sua reunião é em 2 dias!",
  "whatsappId": "{{whatsappId}}",
  "active": true
}

CampaignCancel

Cancela campaign.

Corpo da requisição

{}

CampaignContactsAdd

Adiciona campaign contacts.

Corpo da requisição

[
  {
    "name": "Contato 1",
    "number": "5511999990001"
  },
  {
    "name": "Contato 2",
    "number": "5511999990002"
  }
]

CampaignContactsList

Lista campaign contacts.

CampaignContactsRemove

Remove campaign contacts.

Corpo da requisição

{}

CampaignContactsRemoveAll

Lista todos campaign contacts remove.

Corpo da requisição

{}

CampaignCreate

Cria campaign.

Corpo da requisição

{
  "name": "Campanha Teste",
  "start": "2026-04-10T10:00:00.000Z",
  "message1": "Olá {nome}!",
  "message2": "Como vai?",
  "message3": "Até logo!",
  "sessionId": "{{sessionId}}",
  "delay": "5"
}

CampaignDelete

Remove campaign.

Corpo da requisição

{}

CampaignDuplicate

Endpoint: campaign duplicate.

Corpo da requisição

{}

CampaignList

Lista campaign.

Parâmetros de query

CampaignPause

Endpoint: campaign pause.

Corpo da requisição

{}

CampaignReport

Endpoint: campaign report.

CampaignResume

Endpoint: campaign resume.

Corpo da requisição

{}

CampaignSkip

Endpoint: campaign skip.

Corpo da requisição

{}

CampaignStart

Inicia campaign.

Corpo da requisição

{}

CampaignUpdate

Atualiza campaign.

Corpo da requisição

{
  "name": "Campanha Atualizada",
  "start": "2026-04-15T10:00:00.000Z",
  "message1": "Olá!",
  "message2": "Tudo bem?",
  "message3": "Até logo!",
  "sessionId": "{{sessionId}}"
}

CreateSession

Cria session.

Corpo da requisição

{
    // Nome da instância do WhatsApp
    "name": "My WhatsApp Instance",
    
    // Status inicial da sessão (DISCONNECTED, CONNECTED)
    "status": "DISCONNECTED",
    
    // Tipo da sessão
    "type": "baileys"
}

DeleteSession

Remove session.

Corpo da requisição

{
    // ID da sessão do WhatsApp que será deletada
    "whatsappId": 1
}

ListGroupsInfo

Lista groups info.

Corpo da requisição

{
    //lista todos os grupos
    "listGroups": true, 
    
    //lista todos os grupos e adiciona o array de participantes
    "listParticipants": true 

    // opicional (lista dados de um grupo específico ex: idDoGrupo@g.us)
    // "groupId": "46211553263266@g.us" 
}

RequestNewQrCode

Endpoint: request new qr code.

Corpo da requisição

{
    // ID da sessão do WhatsApp que terá um novo QR Code gerado
    "whatsappId": 1
}

ShowChannelInformation

Exibe channel information.

Corpo da requisição

{
    // Número do WhatsApp do canal (formato: 5511999999999)
    "number": "5515998566622"
}

ShowChannelInformationById

Exibe channel information by id.

Corpo da requisição

{
    // ID do canal que será consultado
    "id": 43
}

ShowQrCode

Exibe qr code.

Corpo da requisição

{
    // ID da sessão do WhatsApp que terá o QR Code gerado
    "whatsappId": 1
}

StartSession

Inicia session.

Corpo da requisição

{
    // ID da sessão do WhatsApp que será iniciada
    "whatsappId": 1
}

BlockContact

Endpoint: block contact.

Corpo da requisição

{
    // ID do contato que será bloqueado/desbloqueado
    "contactId": 1,
    
    // true para bloquear, false para desbloquear
    "blocked": true
}

CreateContact

Cria contact.

Corpo da requisição

{
    // Nome completo do contato
    "name": "Nome", 
    
    // Número do WhatsApp (formato: 5511999999999)
    "number": "5515998566622", 
    
    // Email do contato
    "email": "contato@email.com",
    
    // CPF do contato (formato: 000.000.000-00)
    "cpf": "012.345.678.91",
    
    // Primeiro nome do contato
    "firstName": "Nome Principal",
    
    // Sobrenome do contato
    "lastName": "Sobrenome",
    
    // Nome da empresa do contato
    "businessName": "Empresa",
    
    // Data de nascimento (formato: DD/MM/AAAA)
    "birthdayDate": "01/01/1990",
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)
    "externalKey": "{{SecretKey}}"
}

GetContactExtraInfo

Busca contact extra info.

Parâmetros de query

SearchContacts

Busca contacts.

Corpo da requisição

{
    // Parâmetro de busca textual (opcional) - busca em nome, número, CPF, etc
    "searchParam": "",
    
    // Número da página (padrão: 1)
    "page": 1,
    
    // Limite de resultados por página (padrão: 40)
    "limit": 40,
    
    // ID de uma tag para filtrar (opcional)
    "tagId": 1,
    
    // OU array de IDs de tags para filtrar por múltiplas tags (opcional)
    // "tagIds": [1, 2, 3],
    
    // ID da wallet para filtrar (opcional)
    // "walletId": 1,
    
    // Filtrar por contatos bloqueados (opcional: true/false)
    // "blocked": false
}

ShowContact

Exibe contact.

Corpo da requisição

{
    // Número do WhatsApp do contato (formato: 5511999999999)
    "number": "5515998566622"
}

UpdateContact

Atualiza contact.

Corpo da requisição

{
    // Nome completo do contato
    "name": "Nome", 
    
    // Número do WhatsApp (formato: 5511999999999)
    "number": "5515998566622", 
    
    // Email do contato
    "email": "contato@email.com",
    
    // CPF do contato (formato: 000.000.000-00)
    "cpf": "012.345.678.91",
    
    // Primeiro nome do contato
    "firstName": "Nome Principal",
    
    // Sobrenome do contato
    "lastName": "Sobrenome",
    
    // Nome da empresa do contato
    "businessName": "Empresa",
    
    // Data de nascimento (formato: DD/MM/AAAA)
    "birthdayDate": "01/01/1990",
    
    // ID do kanban do contato
    "kanban": 2,
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
    "externalKey": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK"
}

UpdateContactExtraInfo

Atualiza contact extra info.

Corpo da requisição

{
    // ID do contato que terá as informações adicionais atualizadas
    "contactId": 1,
    
    // Array de campos personalizados (extraInfo)
    "extraInfo": [
        {
            "name": "Campo Personalizado 1",
            "value": "Valor do campo 1"
        },
        {
            "name": "Campo Personalizado 2",
            "value": "Valor do campo 2"
        }
    ]
}

UpdateContactKanban

Atualiza contact kanban.

Corpo da requisição

{
    // ID do contato que terá o kanban (carteira) alterado
    "contactId": 1,
    
    // ID do kanban (carteira) que será atribuído ao contato
    "kanban": 2
}

UpdateContactWallet

Atualiza contact wallet.

Corpo da requisição

{
    // ID do contato que será carteirizado
    "contactId": 1,
    
    // ID da wallet que será atribuída ao contato (pode usar walletId ou walletIds)
    "walletId": 2,
    
    // OU array de IDs de wallets para atribuir múltiplas wallets de uma vez
    // "walletIds": [1, 2, 3]
}

PipelineCreate

Cria pipeline.

Corpo da requisição

{
  "name": "Funil de Vendas",
  "description": "Pipeline principal"
}

PipelineDelete

Remove pipeline.

Corpo da requisição

{}

PipelineList

Lista pipeline.

Parâmetros de query

PipelineShow

Exibe pipeline.

PipelineUpdate

Atualiza pipeline.

Corpo da requisição

{
  "name": "Funil Atualizado"
}

StageCreate

Cria stage.

Corpo da requisição

{
  "name": "Prospecção",
  "pipelineId": "{{pipelineId}}",
  "order": 1
}

StageDelete

Remove stage.

Corpo da requisição

{}

StageList

Lista stage.

Parâmetros de query

StageShow

Exibe stage.

StageUpdate

Atualiza stage.

Corpo da requisição

{
  "name": "Qualificação"
}

DashTicketsAndTimes

Endpoint: dash tickets and times.

Parâmetros de query

DashTicketsChannels

Endpoint: dash tickets channels.

Parâmetros de query

DashTicketsEvolution

Endpoint: dash tickets evolution.

Parâmetros de query

DashTicketsEvolutionByValue

Endpoint: dash tickets evolution by value.

Parâmetros de query

DashTicketsEvolutionChannelsName

Endpoint: dash tickets evolution channels name.

Parâmetros de query

DashTicketsPerUser

Endpoint: dash tickets per user.

Parâmetros de query

DashTicketsQueue

Endpoint: dash tickets queue.

Parâmetros de query

DashTicketsReasons

Endpoint: dash tickets reasons.

Parâmetros de query

DashTicketsStatus

Endpoint: dash tickets status.

Parâmetros de query

DashTicketsUser

Endpoint: dash tickets user.

Parâmetros de query

BulkDispatchIncrementProgress

Endpoint: bulk dispatch increment progress.

Corpo da requisição

{
  "success": true
}

BulkDispatchList

Lista bulk dispatch.

Parâmetros de query

BulkDispatchShow

Exibe bulk dispatch.

BulkDispatchUpdate

Atualiza bulk dispatch.

Corpo da requisição

{
  "status": "cancelled",
  "cancellationReason": "Cancelado pelo usuário"
}

BulkFastMessage

Endpoint: bulk fast message.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "whatsappType": "baileys",
  "arrayNumbers": [
    "5511999990001",
    "5511999990002"
  ],
  "message": "Olá, mensagem rápida!",
  "min": 3,
  "max": 8
}

BulkIndividual

Endpoint: bulk individual.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "number": "5511999990001",
  "message": "Olá, mensagem individual!",
  "externalKey": "{{SecretKey}}"
}

BulkSendMessage

Envia bulk message.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "arrayNumbers": [
    "5511999990001",
    "5511999990002"
  ],
  "message": "Olá, tudo bem?",
  "min": 3,
  "max": 8
}

BulkSendMessageWithVariable

Envia bulk message with variable.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "message": "Olá {nome}, seu código é {codigo}",
  "dataInput": "5511999990001,João,ABC123\n5511999990002,Maria,DEF456",
  "min": 3,
  "max": 8
}

GalleryDelete

Remove gallery.

Corpo da requisição

{}

GalleryList

Lista gallery.

Parâmetros de query

GalleryUpload

Faz upload de gallery.

Corpo da requisição

{
  "description": "Arquivo de marketing"
}

GroupAddParticipant

Adiciona group participant.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

GroupChangeDescription

Endpoint: group change description.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "description": "Nova descrição do grupo"
}

GroupChangePicture

Endpoint: group change picture.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "picture": "https://exemplo.com/foto.jpg"
}

GroupChangeTitle

Endpoint: group change title.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "title": "Novo Título do Grupo"
}

GroupCreate

Cria group.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "titles": [
    "Meu Grupo 1"
  ],
  "number": "5511999990001"
}

GroupDemote

Endpoint: group demote.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

GroupGetInviteLink

Busca group invite link.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupId": "{{groupId}}"
}

GroupList

Lista group.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}"
}

GroupListParticipants

Lista group participants.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ]
}

GroupPromote

Endpoint: group promote.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

GroupRemoveParticipant

Remove group participant.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "participants": [
    "5511999990001"
  ]
}

GroupSetAdminsOnly

Endpoint: group set admins only.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupIds": [
    "{{groupId}}"
  ],
  "adminsOnly": true
}

GroupShowById

Exibe group by id.

Corpo da requisição

{
  "whatsappId": "{{whatsappId}}",
  "groupId": "{{groupId}}"
}

BaileysQuickReply

Endpoint: baileys quick reply.

Corpo da requisição

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opcao:"
  },
  "footer": {
    "text": "Rodape opcional"
  },
  "buttons": [
    {
      "display_text": "Opcao 1",
      "id": "op1"
    },
    {
      "display_text": "Opcao 2",
      "id": "op2"
    }
  ]
}

BaileysSingleSelect

Endpoint: baileys single select.

Corpo da requisição

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opcao:"
  },
  "footer": {
    "text": "Rodape"
  },
  "list": {
    "title": "Ver opcoes",
    "sections": [
      {
        "title": "Secao 1",
        "rows": [
          {
            "id": "1",
            "title": "Item 1",
            "description": "Descricao"
          },
          {
            "id": "2",
            "title": "Item 2"
          }
        ]
      }
    ]
  }
}

BaileysPixButton

Endpoint: baileys pix button.

Corpo da requisição

{
  "ticketId": 1262,
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiario",
  "bodyText": "Pague com PIX:"
}

BaileysCtaCopy

Endpoint: baileys cta copy.

Corpo da requisição

{
  "ticketId": 1262,
  "body": {
    "text": "Copie seu codigo:"
  },
  "footer": {
    "text": "Valido por 24h"
  },
  "displayText": "Copiar codigo",
  "copyCode": "BR123456789"
}

BaileysCtaUrl

Endpoint: baileys cta url.

Corpo da requisição

{
  "ticketId": 1262,
  "body": {
    "text": "Acesse nosso site:"
  },
  "footer": {
    "text": "Clique para visitar"
  },
  "displayText": "Visitar site",
  "url": "https://exemplo.com"
}

BaileysCtaCall

Endpoint: baileys cta call.

Corpo da requisição

{
  "ticketId": 1262,
  "body": {
    "text": "Precisa de ajuda?"
  },
  "footer": {
    "text": "Ligue para nos"
  },
  "displayText": "Ligar agora",
  "phoneNumber": "+5511999999999"
}

Quick Reply

Endpoint: quick reply.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "message": "Escolha uma opção:",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "Sim",
      "payload": "YES"
    },
    {
      "content_type": "text",
      "title": "Não",
      "payload": "NO"
    },
    {
      "content_type": "user_phone_number"
    }
  ]
}

Button Template

Endpoint: button template.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "message": "Clique em uma opção:",
  "buttons": [
    {
      "type": "postback",
      "title": "Comprar",
      "payload": "BUY"
    },
    {
      "type": "postback",
      "title": "Falar com atendente",
      "payload": "HUMAN"
    }
  ]
}

Generic Template (cards)

Endpoint: generic template cards.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "elements": [
    {
      "title": "Produto 1",
      "subtitle": "Descrição",
      "image_url": "https://...",
      "buttons": [
        {
          "type": "postback",
          "title": "Ver",
          "payload": "PROD_1"
        }
      ]
    }
  ]
}

Ice Breakers (get/set/delete)

Endpoint: ice breakers get set delete.

Headers

Corpo da requisição

{
  "action": "set",
  "iceBreakers": [
    {
      "question": "Qual o horário?",
      "payload": "HOURS"
    },
    {
      "question": "Vocês fazem entrega?",
      "payload": "DELIVERY"
    }
  ]
}

Persistent Menu (get/set/delete)

Endpoint: persistent menu get set delete.

Headers

Corpo da requisição

{
  "action": "set",
  "composerInputDisabled": false,
  "menuItems": [
    {
      "type": "postback",
      "title": "Menu",
      "payload": "MAIN_MENU"
    },
    {
      "type": "web_url",
      "title": "Site",
      "url": "https://..."
    }
  ]
}

Quick Reply

Endpoint: quick reply.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "message": "Escolha:",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "Sim",
      "payload": "YES"
    },
    {
      "content_type": "text",
      "title": "Não",
      "payload": "NO"
    }
  ]
}

Button Template

Endpoint: button template.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "message": "Opções:",
  "buttons": [
    {
      "type": "postback",
      "title": "Opção 1",
      "payload": "OPT_1"
    },
    {
      "type": "web_url",
      "title": "Visitar",
      "url": "https://..."
    }
  ]
}

Generic Template (cards)

Endpoint: generic template cards.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "elements": [
    {
      "title": "Card 1",
      "subtitle": "Subtítulo",
      "image_url": "https://...",
      "buttons": [
        {
          "type": "postback",
          "title": "Ação",
          "payload": "ACT"
        }
      ]
    }
  ]
}

Media Template (image/video + botões)

Endpoint: media template image video bot es.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "mediaType": "image",
  "mediaUrl": "https://exemplo.com/imagem.jpg",
  "buttons": [
    {
      "type": "postback",
      "title": "Comprar",
      "payload": "BUY"
    }
  ]
}

Receipt Template (recibo)

Endpoint: receipt template recibo.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "receipt": {
    "recipient_name": "João Silva",
    "order_number": "ORD-001",
    "currency": "BRL",
    "payment_method": "PIX",
    "summary": {
      "total_cost": 150.0
    },
    "elements": [
      {
        "title": "Produto A",
        "price": 100.0,
        "quantity": 1
      },
      {
        "title": "Produto B",
        "price": 50.0,
        "quantity": 1
      }
    ]
  }
}

Message Tag (Marketing/Utility)

Endpoint: message tag marketing utility.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "message": "Seu pedido foi aprovado.",
  "tag": "POST_PURCHASE_UPDATE"
}

Customer Feedback Template (NPS/CSAT)

Endpoint: customer feedback template n p s c s a t.

Headers

Corpo da requisição

{
  "ticketId": 123,
  "title": "Avalie sua experiência",
  "subtitle": "Opcional",
  "business_privacy_url": "https://exemplo.com/privacidade",
  "expires_in_days": 7,
  "feedback_screens": [
    {
      "questions": [
        {
          "id": "CSAT",
          "type": "csat",
          "title": "Como foi nosso atendimento?"
        }
      ]
    }
  ]
}

Greeting Text (get/set/delete)

Endpoint: greeting text get set delete.

Headers

Corpo da requisição

{
  "action": "set",
  "greetings": [
    {
      "locale": "default",
      "text": "Olá! Como podemos ajudar?"
    }
  ]
}

Personas (list/create/delete)

Endpoint: personas list create delete.

Headers

Corpo da requisição

{
  "action": "create",
  "name": "Atendente Ana",
  "profilePictureUrl": "https://exemplo.com/ana.jpg"
}

UazapiButton

Endpoint: uazapi button.

Corpo da requisição

{
  "ticketId": 1262,
  "text": "Escolha uma opcao:",
  "choices": [
    "Opcao 1",
    "Opcao 2",
    "Opcao 3"
  ],
  "footerText": "Rodape opcional",
  "imageButton": "https://exemplo.com/img.png"
}

UazapiList

Lista uazapi.

Corpo da requisição

{
  "ticketId": 1262,
  "text": "Escolha uma opcao:",
  "choices": [
    "Item 1",
    "Item 2",
    "Item 3",
    "Item 4"
  ],
  "listButton": "Ver opcoes",
  "footerText": "Selecione uma opcao"
}

UazapiPoll

Endpoint: uazapi poll.

Corpo da requisição

{
  "ticketId": 1262,
  "text": "Qual sua preferencia?",
  "choices": [
    "Opcao A",
    "Opcao B",
    "Opcao C"
  ],
  "selectableCount": 1
}

UazapiCarousel

Endpoint: uazapi carousel.

Corpo da requisição

{
  "ticketId": 1262,
  "text": "Confira nossas opcoes:",
  "carousel": [
    {
      "text": "Produto A",
      "image": "https://exemplo.com/a.png",
      "buttons": [
        {
          "text": "Ver detalhes",
          "type": "REPLY"
        }
      ]
    },
    {
      "text": "Produto B",
      "image": "https://exemplo.com/b.png",
      "buttons": [
        {
          "text": "Comprar",
          "type": "URL"
        }
      ]
    }
  ]
}

UazapiPixButton

Endpoint: uazapi pix button.

Corpo da requisição

{
  "ticketId": 1262,
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiario"
}

UazapiLocationButton

Endpoint: uazapi location button.

Corpo da requisição

{
  "ticketId": 1262,
  "text": "Por favor, compartilhe sua localizacao:"
}

UazapiRequestPayment

Endpoint: uazapi request payment.

Corpo da requisição

{
  "ticketId": 1262,
  "amount": 150.0,
  "title": "Pedido #001",
  "text": "Sua cobranca esta pronta:",
  "footer": "Vencimento em 3 dias",
  "itemName": "Produto X",
  "invoiceNumber": "NF-001",
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiario"
}

SendButtonWABA

Envia button w a b a.

Corpo da requisição

{
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Mensagem que acompanhará os botões
    "message": "Escolha uma opção:",
    
    // Texto do primeiro botão
    "button1": "Opção 1",
    
    // Texto do segundo botão
    "button2": "Opção 2",
    
    // Texto do terceiro botão (opcional)
    "button3": "Opção 3",
    
    // ID do ticket 
    "ticketId": 1262
}

SendListWABA

Lista send w a b a.

Corpo da requisição

{
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Cabeçalho da lista
    "header": "Menu Principal",
    
    // Corpo da lista
    "body": "Escolha uma opção da lista:",
    
    // Rodapé da lista
    "footer": "Selecione uma opção",
    
    // Texto do botão
    "button_text": "Ver opções",
    
    // Seções da lista (array de objetos)
    "sections": [
        {
            "title": "Seção 1",
            "rows": [
                {
                    "id": "1",
                    "title": "Opção 1",
                    "description": "Descrição da opção 1"
                },
                {
                    "id": "2",
                    "title": "Opção 2",
                    "description": "Descrição da opção 2"
                }
            ]
        }
    ],
    
    // ID do ticket
    "ticketId": 1262
}

CreateKanban

Cria kanban.

Corpo da requisição

{
  "name": "Coluna 1"
}

CreateQueueData

Cria queue data.

Corpo da requisição

{
  "queue": "Suporte",
  "isActive": true
}

CreateReason

Cria reason.

Corpo da requisição

{
  "name": "Resolvido"
}

CreateTag

Cria tag.

Corpo da requisição

{
  "tag": "Urgente",
  "color": "#FF0000",
  "isActive": true
}

DeleteKanban

Remove kanban.

Corpo da requisição

{}

DeleteQueueData

Remove queue data.

Corpo da requisição

{}

DeleteReason

Remove reason.

Corpo da requisição

{}

DeleteTag

Remove tag.

Corpo da requisição

{}

ListKanban

Lista kanban.

ListReasons

Lista reasons.

UpdateKanban

Atualiza kanban.

Corpo da requisição

{
  "name": "Coluna Atualizada"
}

UpdateQueueData

Atualiza queue data.

Corpo da requisição

{
  "queue": "Suporte v2",
  "isActive": true
}

UpdateReason

Atualiza reason.

Corpo da requisição

{
  "name": "Resolvido com sucesso"
}

UpdateTagData

Atualiza tag data.

Corpo da requisição

{
  "tag": "Urgente v2",
  "color": "#CC0000"
}

GetAllSessionApis

Lista todos get session apis.

ListChannels

Lista channels.

ListContacts

Lista contacts.

Parâmetros de query

ListOpportunities

Lista opportunities.

Parâmetros de query

ListQueues

Lista queues.

ListSessions

Lista sessions.

ListTags

Lista tags.

Parâmetros de query

ListTickets

Lista tickets.

Parâmetros de query

ListAutoReplies

Lista auto replies.

ListChatFlows

Lista chat flows.

ListFastReplies

Lista fast replies.

CallLogList

Lista call log.

Parâmetros de query

CallLogShow

Exibe call log.

WavoipCallList

Lista wavoip call.

Parâmetros de query

WavoipCallShow

Exibe wavoip call.

GetMessageByMessageId

Busca message by message id.

Parâmetros de query

SendMessageAPIFile

Envia message a p i file.

Corpo da requisição

media: 
body: Mensagem de teste 2
number: 5515998566622
externalKey: {{SecretKey}}
isClosed: false

SendMessageAPIFileURL

Envia message a p i file u r l.

Corpo da requisição

{
    // URL do arquivo que será enviado (imagem, documento, etc)
    "mediaUrl": "https://comunidadezdg.com.br/wp-content/uploads/2022/07/icon100.png",
    
    // Texto da mensagem que acompanhará o arquivo
    "body": "A mensagem desejada",
    
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)
    "externalKey": "{{SecretKey}}",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false
}

SendMessageAPIText

Envia message a p i text.

Corpo da requisição

{
    // Texto da mensagem que será enviada
    "body": "A mensagem desejada",
    
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)
    "externalKey": "{{SecretKey}}",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false
}

SendMessageAPITextBase64

Envia message a p i text base.

Corpo da requisição

{
    // Texto da mensagem que acompanhará o arquivo
    "body": "A mensagem desejada",
    
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Arquivo codificado em base64
    "base64Data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    
    // Tipo MIME do arquivo (ex: image/png, application/pdf)
    "mimeType": "image/png",
    
    // Nome do arquivo que será exibido
    "fileName": "exemplo_imagem",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false
}

SendMessageAPIVoice

Envia message a p i voice.

Corpo da requisição

{
    // URL do arquivo de áudio que será enviado
    "audio": "https://comunidadezdg.com.br/wp-content/uploads/2022/12/audio.ogg",
    
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)
    "externalKey": "{{SecretKey}}",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false
}

SendMessageParams

Envia message params.

Parâmetros de query

SearchMessages

Busca messages.

Parâmetros de query

SendLocation

Envia location.

Corpo da requisição

{
  "number": "5511999990001",
  "latitude": -23.5505,
  "longitude": -46.6333,
  "name": "São Paulo",
  "address": "Av. Paulista, 1000",
  "ticketId": null,
  "externalKey": "{{SecretKey}}"
}

SendVcard

Envia vcard.

Corpo da requisição

{
  "number": "5511999990001",
  "contact": [
    {
      "fullName": "João Silva",
      "wuid": "5511999990002@s.whatsapp.net",
      "phoneNumber": "5511999990002"
    }
  ],
  "ticketId": null,
  "externalKey": "{{SecretKey}}"
}

SendGroupMessageAPIFile

Envia group message a p i file.

Corpo da requisição

media: 
body: Mensagem de teste 2
number: 12356818915189153
externalKey: {{SecretKey}}
isClosed: false

SendGroupMessageAPIText

Envia group message a p i text.

Corpo da requisição

{
    // Texto da mensagem que será enviada
    "body": "A mensagem desejada",
    
    // ID do grupo do WhatsApp
    "number": "12356818915189153",
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)
    "externalKey": "{{SecretKey}}",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false
}

SendMessageAPIFileURLGroup

Envia message a p i file u r l group.

Corpo da requisição

{
    // URL do arquivo que será enviado (imagem, documento, etc)
    "mediaUrl": "https://comunidadezdg.com.br/wp-content/uploads/2022/07/icon100.png",
    
    // Texto da mensagem que acompanhará o arquivo
    "body": "A mensagem desejada",
    
    // ID do grupo do WhatsApp
    "number": "12356818915189153",
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)
    "externalKey": "{{SecretKey}}",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false
}

CreateOpportunity

Cria opportunity.

Corpo da requisição

{
  // Campos do contato
  "number": "5535912345678",  // número do WhatsApp
  "contactName": "Nome do Contato",   // nome do contato
  "email": "contato@email.com", // email do contato

  // Campos da oportunidade
  "name": "Nome da Oportunidade 2", // nome da oportunidade
  "value": 10000.00,              // valor da oportunidade
  "status": "open",              // pode ser: "open", "win", "lose"
  "pipelineId": 16,               // ID do pipeline
  "stageId": 7,                  // ID do estágio
  "responsibleId": 1,            // ID do responsável
  "closingForecast": "2024-12-31", // data esperada de fechamento
  "description": "Descrição da oportunidade" // descrição da oportunidade
}

DeleteOpportunity

Remove opportunity.

Corpo da requisição

{
  // Campos da oportunidade
  "opportunityId": 19 // id da oportunidade
}

UpdateOpportunity

Atualiza opportunity.

Corpo da requisição

{
  // Campos da oportunidade
  "opportunityId": 30, // id da oportunidade
  "name": "Nome da Oportunidade 2 API", // nome da oportunidade
  "value": 500.00,              // valor da oportunidade
  "status": "open",              // pode ser: "open", "win", "lose"
  "pipelineId": 16,               // ID do pipeline
  "stageId": 7,                  // ID do estágio
  "responsibleId": 1,            // ID do responsável
  "closingForecast": "2024-12-31", // data esperada de fechamento
  "description": "Descrição da oportunidade" // descrição da oportunidade
}

SendTemplateWaba

Envia template waba.

Corpo da requisição

{
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false,
    
    // Dados do template do WhatsApp Business API
    "templateData": {
        // Produto de mensageria (sempre whatsapp)
        "messaging_product": "whatsapp",
        
        // Número do destinatário (mesmo do campo number)
        "to": "5515998566622",
        
        // Tipo da mensagem (sempre template)
        "type": "template",
        
        // Configurações do template
        "template": {
            // Nome do template aprovado
            "name": "hello_world",
            
            // Configurações de idioma
            "language": {
                // Código do idioma (ex: en_US, pt_BR)
                "code": "en_US"
            }
        }
    }
}

SendTemplateWabaBody

Envia template waba body.

Corpo da requisição

{
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false,
    
    // Dados do template do WhatsApp Business API
    "templateData": {
        // Produto de mensageria (sempre whatsapp)
        "messaging_product": "whatsapp",
        
        // Número do destinatário (mesmo do campo number)
        "to": "5515998566622",
        
        // Tipo da mensagem (sempre template)
        "type": "template",
        
        // Configurações do template
        "template": {
            // Nome do template aprovado
            "name": "hello_world",
            
            // Configurações de idioma
            "language": {
                // Código do idioma (ex: en_US, pt_BR)
                "code": "en_US"
            }
        }
    }
}

SendTemplateWabaMarketing

Envia template waba marketing.

Corpo da requisição

{
    // Número do WhatsApp do destinatário (formato: 5511999999999)
    "number": "5515998566622",
    
    // Define se o ticket será fechado após o envio
    "isClosed": false,
    
    // Dados do template do WhatsApp Business API
    "templateData": {
        // Produto de mensageria (sempre whatsapp)
        "messaging_product": "whatsapp",
        
        // Número do destinatário (mesmo do campo number)
        "to": "5515998566622",
        
        // Tipo da mensagem (sempre template)
        "type": "template",
        
        // Configurações do template
        "template": {
            // Nome do template aprovado
            "name": "hello_world",
            
            // Configurações de idioma
            "language": {
                // Código do idioma (ex: en_US, pt_BR)
                "code": "en_US"
            }
        }
    }
}

CreateApi

Cria api.

Corpo da requisição

{
    // Nome da API que será criada
    "name": "API 1",
    
    // ID da sessão do WhatsApp associada
    "sessionId": 1,
    
    // URL para receber atualizações de status do serviço (opcional)
    "urlServiceStatus": null,
    
    // URL para receber atualizações de status das mensagens (opcional)
    "urlMessageStatus": null,
    
    // ID do usuário que está criando a API
    "userId": 1,
    
    // Token de autenticação para a API
    "authToken": "123456",
    
    // ID do tenant que terá a API
    "tenant": 1
}

CreateSessionTenant

Cria session tenant.

Corpo da requisição

{
    // Tenant
    "tenant": 1,

    // Nome da instância do WhatsApp
    "name": "My WhatsApp Instance",
    
    // Status inicial da sessão (DISCONNECTED, CONNECTED)
    "status": "DISCONNECTED",
    
    // Tipo da sessão (whatsapp, baileys, meow, evo, uazapi, zapi)
    "type": "baileys"
}

DeleteApi

Remove api.

Corpo da requisição

{
    // ID da sessão do WhatsApp associada à API
    "sessionId": 43,
    
    // ID do usuário que está deletando a API
    "userId": 1,
    
    // ID do tenant que possui a API
    "tenant": 1,
    
    // ID da API que será deletada
    "apiId": "5ec32c80-4549-4256-8ed1-ed57b86396c3"
}

ListTenants

Lista tenants.

ShowTenant

Exibe tenant.

Corpo da requisição

{
    // ID do tenant que será consultado
    "id": 1
}

StoreTenant

Endpoint: store tenant.

Corpo da requisição

{
    // Status do tenant (active, inactive)
    "status": "active",
    
    // Nome da empresa/tenant
    "name": "Empresa Exemplo",
    
    // Número máximo de usuários permitidos
    "maxUsers": 3,
    
    // Número máximo de conexões WhatsApp permitidas
    "maxConnections": 3,
    
    // Confirmação de aceite dos termos
    "acceptTerms": true,
    
    // Email do administrador do tenant
    "email": "user@example.com",
    
    // Senha do administrador (mínimo 8 caracteres, incluindo números e caracteres especiais)
    "password": "securePassword123!",
    
    // Nome completo do administrador
    "userName": "Pedro Bastos",
    
    // Perfil do administrador (admin, user)
    "profile": "admin"
}

UpdateTenant

Atualiza tenant.

Corpo da requisição

{
    // Identidade do tenant (CPF/CNPJ) - identificador usado para reconhecer qual tenant será atualizado
    "identity": "07122989674",

    // Status do tenant (active, inactive)
    "status": "active",

    // Número máximo de usuários permitidos
    "maxUsers": 100,

    // Número máximo de conexões permitidas
    "maxConnections": 10,

    // Gateway de pagamento (none, asaas, mercadopago, stripe, pagarme)
    "paymentGateway": "asaas",

    // Chat de suporte habilitado (enabled, disabled)
    "supportChatEnabled": "enabled",

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

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

    // Limite máximo de conexões por tipo de canal. Use 0 para ilimitado.
    "channelConnectionLimits": {
        "waba": 0,
        "baileys": 0,
        "whatsapp": 0,
        "meow": 0,
        "evo": 0,
        "zapi": 0,
        "uazapi": 0,
        "telegram": 0,
        "hub": 0,
        "webchat": 0,
        "webmail": 0,
        "wabaoauth": 0,
        "instagramoauth": 0,
        "facebookoauth": 0
    },

    // OAuth (Meta Embedded Signup)
    // OAuth habilitado (true/false)
    "oauthEnabled": false,

    // URL do Proxy OAuth
    "oauthProxyUrl": "https://proxy.exemplo.com/oauth",

    // URL do Proxy de Webhook Instagram
    "instagramWebhookProxyUrl": "https://proxy.exemplo.com/instagram/webhook",

    // Segredo do Proxy Instagram
    "instagramWebhookProxySecret": "secret_instagram",

    // URL do Proxy de Webhook Messenger
    "messengerWebhookProxyUrl": "https://proxy.exemplo.com/messenger/webhook",

    // Segredo do Proxy Messenger
    "messengerWebhookProxySecret": "secret_messenger"
}

AddTag

Adiciona tag.

Corpo da requisição

{
    // ID do ticket que receberá a tag
    "ticketId": 4,
    
    // ID da tag que será adicionada (pode usar tagId ou tagIds)
    "tagId": 1,
    
    // OU array de IDs de tags para adicionar múltiplas tags de uma vez
    // "tagIds": [1, 2, 3]
}

CreateNotes

Cria notes.

Corpo da requisição

{
    // Texto da nota que será adicionada ao ticket
    "notes": "Mensagem da nota", 
    
    // ID do ticket que receberá a nota
    "ticketId": 1262, 
    
    // ID do usuário que está criando a nota
    "userId": 1,
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
    "idFront": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK"
}

CreateTicket

Cria ticket.

Corpo da requisição

{
    // Texto da mensagem inicial do ticket
    "body": "A mensagem desejada",
    
    // Para canais WhatsApp/outros: número do contato (formato: 5511999999999)
    "number": "5535988754197",
    
    // Para canal WEBMAIL: email do contato (obrigatório quando channelId for de um canal webmail)
    // "email": "contato@exemplo.com",
    
    // ID do canal (opcional). Para webmail: envie o id do canal webmail (não vem do APIConfig)
    // "channelId": 17841443941506797,
    
    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)
    "externalKey": "{{SecretKey}}",
    
    // ID do usuário que está criando o ticket
    "userId": 3,
    
    // Status inicial do ticket (pending ou open)
    "status": "pending",
    
    // ID do kanban (opcional)
    // "kanbanId": 1,
    
    // ID do fluxo de chat (opcional)
    // "chatFlowId": 16,
    
    // ID da fila (opcional)
    // "queueId": 1,
    
    // ID da demanda (opcional)
    // "reasonId": 1,
    
    // Valor do ticket (opcional)
    // "value": 10.25,
    
    // Para webmail: nome do contato (opcional, usado na criação do contato)
    // "name": "Nome do Contato",
    // "firstName": "Nome",
    // "lastName": "Sobrenome"
}

CreateTicketFile

Cria ticket file.

Corpo da requisição

media: 
body: Mensagem de teste 2
number: 5515998566622
externalKey: {{SecretKey}}
userId: 3
status: pending
kanbanId: 1
chatFlowId: 10
queueId: 1
channelId: 
email: 
name: 

CreateTicketWebmail

Cria ticket webmail.

Corpo da requisição

{
    // Texto da mensagem inicial do ticket
    "body": "Mensagem inicial do ticket por email",
    
    // Email do contato (obrigatório para webmail)
    "email": "contato@exemplo.com",
    
    // ID do canal webmail (opcional; se não enviar, usa canal da APIConfig)
    "channelId": 17841443941506797,
    
    "externalKey": "{{SecretKey}}",
    "userId": 3,
    "status": "pending",
    
    // Opcionais: nome do contato (usado ao criar contato se não existir)
    "name": "Nome do Contato",
    "firstName": "Nome",
    "lastName": "Sobrenome",
    
    // "kanbanId": 1,
    // "chatFlowId": 16,
    // "queueId": 1,
    // "reasonId": 1,
    // "value": 10.25
}

ListNotes

Lista notes.

Parâmetros de query

RemoveTag

Remove tag.

Corpo da requisição

{
    // ID do ticket que terá a tag removida
    "ticketId": 4,
    
    // ID da tag que será removida (pode usar tagId ou tagIds)
    "tagId": 1,
    
    // OU array de IDs de tags para remover múltiplas tags de uma vez
    // "tagIds": [1, 2, 3]
}

SendPresence

Envia presence.

Corpo da requisição

{
    // ID do ticket associado
    "ticketId": 1262,
    
    // Estado de presence: "typing" (digitando), "paused" (pausado) ou "recording" (gravando)
    "state": "typing"
}

SetQueue

Endpoint: set queue.

Corpo da requisição

{
    // ID do ticket que terá a fila alterada
    "ticketId": 4,
    
    // ID da fila que será atribuída ao ticket
    "queueId": 1
}

SetTag

Endpoint: set tag.

Corpo da requisição

{
    // ID do ticket que terá a tag alterada
    "ticketId": 4,
    
    // ID da tag que será atribuída ao ticket
    "tag": 1
}

SetTicketInfo

Endpoint: set ticket info.

Corpo da requisição

{
    // ID do ticket que será atualizado
    "ticketId": 1262,
    
    // ID do usuário que está fazendo a atualização
    "userId": 1,
    
    // Status do ticket (pending, open, closed)
    "status": "pending",
    
    // ID da fila do ticket (null para remover)
    "queueId": null,
    
    // Status de integração com Typebot
    "typebotStatus": false,
    
    // Status de integração com ChatGPT
    "chatgptStatus": false,
    
    // Status de integração com Dialogflow
    "dialogflowStatus": false,
    
    // Status de integração com Dify
    "difyStatus": false,
    
    // Status de integração com N8N
    "n8nStatus": false,
    
    // ID do fluxo de chat (null para remover)
    "chatFlowId": null
}

ShowAllMessages

Lista todos show messages.

Corpo da requisição

{
    // ID do ticket que terá as mensagens listadas
    "ticket": "123"
}

ShowAllTicketInformation

Lista todos show ticket information.

Corpo da requisição

{
    // Número do WhatsApp do contato (formato: 5511999999999)
    "number": "5515998566622"
}

ShowTicketInformation

Exibe ticket information.

Corpo da requisição

{
    // Número do WhatsApp do contato (formato: 5511999999999)
    "number": "5515998566622"
}

ShowTicketInformationChatBot

Exibe ticket information chat bot.

Corpo da requisição

{
    // Número do WhatsApp do contato (formato: 5511999999999)
    "number": "5515998566622"
}

UpdateNote

Atualiza note.

Corpo da requisição

{
    // ID da nota que será atualizada
    "noteId": 1,
    
    // Novo conteúdo da nota
    "notes": "Conteúdo atualizado da nota"
}

UpdateTicketChannel

Atualiza ticket channel.

Corpo da requisição

{
    // ID do ticket que terá o canal alterado
    "ticketId": 1262,
    
    // ID do novo canal (WhatsApp)
    "whatsappId": 1,
    
    // Tipo do canal (whatsapp, baileys, waba, etc)
    "channel": "whatsapp"
}

EndTicketPause

Endpoint: end ticket pause.

Corpo da requisição

{}

ListTicketEvaluations

Lista ticket evaluations.

Parâmetros de query

ListTicketPauseLogs

Lista ticket pause logs.

ShowTicketById

Exibe ticket by id.

Corpo da requisição

{
  "ticketId": "{{ticketId}}"
}

StartTicketPause

Inicia ticket pause.

Corpo da requisição

{
  "pauseReason": "Aguardando cliente"
}

TicketShareCreate

Cria ticket share.

Corpo da requisição

{
  "ticketId": "{{ticketId}}",
  "inviteUrl": "https://app.example.com/shared"
}

TicketShareShow

Exibe ticket share.

TodoCreate

Cria todo.

Corpo da requisição

{
  "name": "Ligar para cliente",
  "description": "Confirmar proposta",
  "owner": "João",
  "ownerId": "{{userId}}",
  "status": "pending",
  "priority": "high"
}

TodoDelete

Remove todo.

Corpo da requisição

{}

TodoList

Lista todo.

TodoLogs

Endpoint: todo logs.

TodoUpdate

Atualiza todo.

Corpo da requisição

{
  "status": "finished"
}

CreateUser

Cria user.

Corpo da requisição

{
    // Email do usuário
    "email": "usuario@example.com",
    
    // Senha do usuário (mínimo 8 caracteres)
    "password": "senha123",
    
    // Nome completo do usuário
    "name": "Nome do Usuário",
    
    // Perfil do usuário (admin, user)
    "profile": "user"
}

GetUserStatus

Busca user status.

Parâmetros de query

ListUsers

Lista users.

Parâmetros de query

UpdateUser

Atualiza user.

Corpo da requisição

{
    // ID do usuário que será atualizado
    "userId": 1,
    
    // Nome completo do usuário (opcional)
    "name": "Nome Atualizado",
    
    // Email do usuário (opcional)
    "email": "novoemail@example.com"
}