1. Customers
Way API
  • Customers
    • Criar conta de cliente
      POST
    • Ver meus dados
      GET
    • Atualizar meus dados
      PATCH
  • Instances
    • Listar instâncias
      GET
    • Criar instância
      POST
    • Remover instância
      DELETE
    • Listar chats da instância
      GET
    • Conectar instância
      POST
    • Desconectar instância
      POST
    • Consultar status da instância
      GET
    • Atualizar nome da instância
      PATCH
  • Messages
    • Enviar mensagem com imagem
      POST
    • Enviar mensagem com preview de link
      POST
    • Enviar mensagem de texto
      POST
  • Webhooks
    • Criar ou atualizar webhook
      POST
    • Desativar webhook
      DELETE
  • Esquemas
    • AcceptedMessageResponse
    • Chat
    • AudioMessageReceivedContent
    • ConnectInstanceRequest
    • AudioMessageReceivedWebhookPayload
    • ConnectInstanceResponse
    • CreateCustomerRequest
    • CreateCustomerResponse
    • CreateInstanceRequest
    • ContactMessageReceivedContent
    • CreateInstanceResponse
    • ContactMessageReceivedItem
    • CustomerOutput
    • ContactMessageReceivedWebhookPayload
    • DisconnectInstanceResponse
    • ErrorResponse
    • ListChatsResponse
    • GetInstanceStatusResponse
    • SendImageRequest
    • JsonContentTypeHeader
    • SendLinkRequest
    • SendTextRequest
    • DeleteInstanceResponse
    • UpdateCustomerRequest
    • DocumentMessageReceivedContent
    • UpsertWebhookRequest
    • DocumentMessageReceivedWebhookPayload
    • WebhookOutput
    • GifMessageReceivedContent
    • GifMessageReceivedWebhookPayload
    • GroupParticipantUpdateItem
    • GroupParticipantsUpdateMessageReceivedContent
    • GroupParticipantsUpdateMessageReceivedWebhookPayload
    • ImageMessageReceivedContent
    • ImageMessageReceivedWebhookPayload
    • IncomingMediaPayload
    • InstanceOutput
    • InstanceWebhookOutput
    • LocationMessageReceivedContent
    • LocationMessageReceivedWebhookPayload
    • MessageReceiptDetails
    • ListInstancesResponse
    • MessageReceiptUpdateMessageReceivedContent
    • MessageReceiptUpdateMessageReceivedWebhookPayload
    • MessageReceivedWebhookPayloadBase
    • MessageSentWebhookPayload
    • PinMessageInChatMessageReceivedContent
    • PinMessageInChatMessageReceivedWebhookPayload
    • PinMessageReferencedMessage
    • ReactionMessageReceivedContent
    • ReactionMessageReceivedWebhookPayload
    • ReactionReferencedMessage
    • ReceiptReferencedMessage
    • StickerMessageReceivedContent
    • StickerMessageReceivedWebhookPayload
    • TextMessageReceivedContent
    • TextMessageReceivedWebhookPayload
    • UnknownMessageReceivedContent
    • UnknownMessageReceivedWebhookPayload
    • VideoMessageMessageReceivedContent
    • VideoMessageMessageReceivedWebhookPayload
    • VideoMessageReceivedContent
    • VideoMessageReceivedWebhookPayload
    • UpdateInstanceNameRequest
    • WayApiWebhookPayload
    • UpdateInstanceNameResponse
  1. Customers

Criar conta de cliente

Amb. de Desenv.
http://localhost:3000
Amb. de Desenv.
http://localhost:3000
POST
/customers
Cria uma conta de cliente.
Esta rota é pública e limitada a 2 requisições por minuto por IP.
A resposta não retorna apiKey.

Requisição

Authorization
Adicionar parâmetro em header
x-api-key
Exemplo:
x-api-key: ********************
Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado
application/json
Resposta do cadastro. Não inclui apiKey; a chave é obtida no dashboard após login.
Body

🟠400Requisição Inválida
🟠409
🟠422Erro de Parâmetro
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:3000/customers' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Maria Silva",
    "email": "maria@empresa.com",
    "password": "SenhaForte123"
}'
Response Response Example
201 - Cadastro realizado
{
    "customerId": "018f47ac-7a5b-7cc2-9f9a-9b8d7f6e5d4c",
    "name": "Maria Silva",
    "email": "maria@empresa.com"
}
Modificado em 2026-04-17 18:55:00
Próxima página
Ver meus dados
Built with