Nexiyo — Desenvolvedor / API

NEXIYO PARA DESENVOLVEDORES

Obtenha sua chave de API e integre com a Nexiyo

Use os endpoints abaixo para conectar contas do WhatsApp, gerenciar assinantes, catálogos e muito mais.

Sua chave de API

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Sua chave real fica disponível dentro do seu painel Nexiyo, na área de Desenvolvedor. Nunca compartilhe sua chave de API publicamente — trate-a como uma senha.

WhatsApp API

POST Account Connect

Conecte a conta comercial do WhatsApp.

https://app.nexiyo.com.br/api/v1/whatsapp/account/connect

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`user_id`	ID do usuário do proprietário da conta do WhatsApp	Integer · Obrigatório
`whatsapp_business_account_id`	ID da conta comercial do WhatsApp	String · Obrigatório
`access_token`	Token de acesso	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/account/connect?apiToken=API-KEY&user_id=USER-ID&whatsapp_business_account_id=WHATSAPP-BUSINESS-ACCOUNT-ID&access_token=ACCESS-TOKEN

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/account/connect' \
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID' \
-d 'whatsapp_business_account_id=WHATSAPP-BUSINESS-ACCOUNT-ID' \
-d 'access_token=ACCESS-TOKEN'

Exemplo de resposta

{"status":"1","message":"Whatsapp account has been connect successfully."}

POST Send Text Message

Envie mensagem do WhatsApp para qualquer número de celular. Mensagens de texto podem ser respondidas em até 24h após o contato do cliente (mensagem de sessão); fora desse prazo, use um modelo aprovado.

https://app.nexiyo.com.br/api/v1/whatsapp/send

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`message`	Conteúdo da mensagem de texto (URL-encoded na requisição GET)	String · Obrigatório
`phone_number`	Deve começar com o código do país, apenas números	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&message=TEXT-MESSAGE&phone_number=PHONE-NUMBER

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/send' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'message=TEXT-MESSAGE' \
-d 'phone_number=PHONE-NUMBER'

Exemplo de resposta

{"status":"1", "wa_message_id":"wamid.HBgN...", "message":"Message sent successfully."}

Exemplo de resposta

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

POST Enviar botões interativos

Envie uma mensagem de sessão com até 3 botões de resposta. Opcionalmente anexe imagem, vídeo ou documento como cabeçalho.

https://app.nexiyo.com.br/api/v1/whatsapp/send/interactive-buttons

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`phone_number`	Deve começar com o código do país, apenas números	String · Obrigatório
`message`	Corpo da mensagem exibido acima dos botões	String · Obrigatório
`buttons`	1 a 3 botões, cada um com id e título (até 20 caracteres)	JSON Array · Obrigatório
`button_header_text`	Cabeçalho de texto opcional (ignorado se houver mídia)	String · Opcional
`button_footer_text`	Texto opcional no rodapé	String · Opcional
`media_url`	URL pública de imagem/vídeo/documento para o cabeçalho	String · Opcional
`media_id`	ID de mídia obtido via Upload Media (requer media_type)	String · Opcional
`media_type`	image, video ou document	String · Opcional
`media_name`	Nome do arquivo, usado só quando media_type é document	String · Opcional

Exemplo de requisição POST

curl -X POST "https://app.nexiyo.com.br/api/v1/whatsapp/send/interactive-buttons" \
  -H "Accept: application/json" \
  -d "apiToken=API-KEY" \
  -d "phone_number_id=PHONE-NUMBER-ID" \
  -d "phone_number=PHONE-NUMBER" \
  -d "message=Would you like to continue?" \
  -d 'buttons=[{"id":"buy_now","title":"Buy Now"},{"id":"details","title":"View Details"}]' \
  -d "button_header_text=Product update" \
  -d "button_footer_text=Tap an option"

Exemplo de resposta

{"status":"1", "wa_message_id":"wamid.HBgN...", "message":"Message sent successfully."}

Exemplo de resposta

{"status":"0","message":"You can send between 1 and 3 reply buttons."}

Exemplo de resposta

{"status":"0","message":"When sending media with buttons, media_type must be one of: image, video, document."}

POST Enviar arquivo/mídia

Envie imagens, vídeos, áudios ou documentos. É obrigatório informar media_url ou media_id (pelo menos um dos dois).

https://app.nexiyo.com.br/api/v1/whatsapp/send/file

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`phone_number`	Deve começar com o código do país, apenas números	String · Obrigatório
`media_url`	URL pública do arquivo (obrigatório se não houver media_id)	String · Opcional
`media_id`	ID de mídia do WhatsApp (obrigatório se não houver media_url)	String · Opcional
`media_type`	image, video, audio ou document — obrigatório com media_id	String · Opcional
`media_caption_text`	Legenda (não se aplica a áudio)	String · Opcional

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/send/file?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_type=image&media_url=https://example.com/image.jpg&message=Caption+text

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/send/file' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'media_url=https://example.com/file.jpg' \
-d 'media_type=image'

Exemplo de resposta

{"status":"1", "wa_message_id":"wamid.HBgN...", "message":"Message sent successfully."}

Exemplo de resposta

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

POST (multipart/form-data) Carregar mídia

Faça upload de um arquivo para obter o media_id e media_type usados na API Send File.

https://app.nexiyo.com.br/api/v1/whatsapp/upload/media

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API (também aceita como Authorization: Bearer)	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`media_file`	Campo do arquivo multipart — imagem, vídeo, áudio ou documento	File · Obrigatório

Exemplo de requisição POST

curl -X POST "https://app.nexiyo.com.br/api/v1/whatsapp/upload/media" \
  -H "Authorization: Bearer API-KEY" \
  -H "Accept: application/json" \
  -F "phone_number_id=PHONE-NUMBER-ID" \
  -F "media_file=@/path/to/local/file.jpg"

Exemplo de resposta

{"status":"1","media_id":"1739230482390482","media_type":"image","message":"Upload successful. Use media_id and media_type with the Send File API."}

GET/POST Get Conversation

Obtenha a conversa de um assinante específico.

https://app.nexiyo.com.br/api/v1/whatsapp/get/conversation

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`limit`	Quantidade de mensagens a retornar	Number · Obrigatório
`offset`	Deslocamento de paginação	Number · Opcional

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/get/conversation?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&limit=10&offset=1

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/get/conversation' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'limit=10' \
-d 'offset=1'

Exemplo de resposta

{"status":"1","message":[{"id":8823,"sender":"bot","message_content":"...","conversation_time":"2026-01-10 13:21:03"}]}

GET/POST Get Post Back List

Obtenha a lista de retorno (postback) configurada para o bot.

https://app.nexiyo.com.br/api/v1/whatsapp/get/post-back-list

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/get/post-back-list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/get/post-back-list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'

Exemplo de resposta

{"status":"1","message":[{"id":671,"postback_id":"QUICK_REPLY_LOCATION_REPLY_BOT","bot_name":"Location quick reply","status":"1"}]}

GET/POST Get Delivery Message Status

Obtenha o status de entrega de uma mensagem enviada.

https://app.nexiyo.com.br/api/v1/whatsapp/get/message-status

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`wa_message_id`	ID da mensagem do WhatsApp a verificar	String · Obrigatório
`whatsapp_bot_id`	ID do bot do WhatsApp	Number · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/get/message-status?apiToken=API-KEY&wa_message_id=WAMID.XXXXX&whatsapp_bot_id=123

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/get/message-status' \
-d 'apiToken=API-KEY' \
-d 'wa_message_id=WAMID.XXXXX' \
-d 'whatsapp_bot_id=123'

Exemplo de resposta

{"status":"1","message":{"message_status":"delivered","delivery_status_updated_at":"2026-01-10 13:21:03"}}

GET/POST Bot Template Get

Obtenha a lista de modelos de mensagem (templates) do WhatsApp cadastrados no bot.

https://app.nexiyo.com.br/api/v1/whatsapp/template/list

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/template/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/template/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'

Exemplo de resposta

{"status":"1","message":{"template_name":"boasvindas","template_type":"single","status":"Approved"}}

GET/POST Trigger Bot Flow

Acione um fluxo do bot para qualquer número de celular.

https://app.nexiyo.com.br/api/v1/whatsapp/trigger-bot

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`bot_flow_unique_id`	ID exclusivo do fluxo do bot	String · Obrigatório
`phone_number`	Deve começar com o código do país, apenas números	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/trigger-bot?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&bot_flow_unique_id=BOT-FLOW-UNIQUE-ID&phone_number=PHONE-NUMBER

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/trigger-bot' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'bot_flow_unique_id=BOT-FLOW-UNIQUE-ID' \
-d 'phone_number=PHONE-NUMBER'

Exemplo de resposta

{"status":"1","message":"Bot has been trigger successfully."}

API de Assinante

POST Subscriber Get

Obtenha um assinante usando o ID de bate-papo (número de telefone).

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/get

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/get' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'

Exemplo de resposta

{"status":"1","message":[{"subscriber_id":144,"first_name":"John","last_name":"Doe","label_names":"Label1,Label2"}]}

GET/POST Subscriber List

Liste os assinantes de um número de WhatsApp.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/list

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`limit`	Quantidade de assinantes (até 100)	Number · Obrigatório
`offset`	Deslocamento de paginação	Number · Opcional

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'limit=10' \
-d 'offset=1'

Exemplo de resposta

{"status":"1","message":[{"subscriber_id":144,"first_name":"John","last_name":"Doe","label_names":"One,two"}]}

POST Subscriber Create

Crie um novo assinante/contato.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/create

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phoneNumberID`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`name`	Nome do assinante	String · Obrigatório
`phoneNumber`	Número de telefone com código do país (sem sinal +)	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/create' \
-d 'apiToken=API-KEY' \
-d 'phoneNumberID=PHONE-NUMBER-ID' \
-d 'name=NAME' \
-d 'phoneNumber=MOBILE'

Exemplo de resposta

{"status":"1","message":"WhatsApp subscriber has been created."}

Exemplo de resposta

{"status":"0","message":"Something went wrong or subscriber already exist."}

POST Subscriber Update

Atualize um assinante existente.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/update

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`first_name`	Primeiro nome	String · Opcional
`last_name`	Sobrenome	String · Opcional
`gender`	Gênero	String · Opcional
`label_ids`	IDs separados por vírgula, ex: 1,4,5	String · Opcional

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/update?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&first_name=FIRST-NAME

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/update' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'first_name=FIRST-NAME'

Exemplo de resposta

{"status":"1","message":"Subscriber Updated Successfully."}

GET/POST Delete Subscriber

Exclua um assinante do WhatsApp.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/delete

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`phone_number`	Deve começar com o código do país, apenas números	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/delete?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/delete' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'

Exemplo de resposta

{"status":"1","message":"Subscriber has been deleted successfully."}

POST Reset User Input Flow

Redefina o fluxo de entrada do usuário.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/reset/user-input-flow

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	ID do número de telefone da conta do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/reset/user-input-flow?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/reset/user-input-flow' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'

Exemplo de resposta

{"status":"1","message":"Reset User Input Flow successfully."}

POST Assign Chat to Team Member

Atribua a conversa de um assinante a um membro da equipe.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-to-team-member

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`team_member_id`	ID do membro da equipe	Integer · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-to-team-member?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&team_member_id=TEAM-MEMBER-ID

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-to-team-member' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'team_member_id=TEAM-MEMBER-ID'

Exemplo de resposta

{"status":"1","message":"Successfully Assign Agent to Conversation."}

POST Assign Custom Fields

Atribua campos personalizados a um assinante.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-custom-fields

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`custom_fields`	Nome e valor dos campos personalizados	JSON · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-custom-fields' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'custom_fields={"customer_name": "John"}'

Exemplo de resposta

{"status":"1","message":"Subscriber changes have been saved successfully."}

POST Custom Fields List

Obtenha a lista de campos personalizados disponíveis.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/custom-fields/list

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/custom-fields/list' \
-d 'apiToken=API-KEY'

Exemplo de resposta

{"status":"1","message":"Custom fields retrieved successfully","data":[{"id":1,"name":"customer_name","reply_type":"text"}]}

POST Assign Labels

Atribua rótulos (etiquetas) a um assinante.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-labels

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`label_ids`	IDs separados por vírgula, ex: 1,4,5	String · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-labels' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'label_ids=LABEL-IDS'

Exemplo de resposta

{"status":"1","message":"Labels have been assigned successfully."}

POST Remove Labels

Remova rótulos de um assinante.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/remove-labels

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`label_ids`	IDs separados por vírgula, ex: 1,4,5	String · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/remove-labels' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'label_ids=LABEL-IDS'

Exemplo de resposta

{"status":"1","message":"Labels have been assigned successfully."}

POST Assign Sequences

Atribua sequências de mensagens a um assinante.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-sequence

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`sequence_ids`	IDs separados por vírgula, ex: 1,4,5	String · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/assign-sequence' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'sequence_ids=SEQUENCE-IDS'

Exemplo de resposta

{"status":"1","message":"Sequences have been assigned successfully."}

POST Remove Sequences

Remova sequências de mensagens de um assinante.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/remove-sequence

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`sequence_ids`	IDs de sequência separados por vírgula	String · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/remove-sequence' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'sequence_ids=SEQUENCE-IDS'

Exemplo de resposta

{"status":"1","message":"Sequences have been removed successfully."}

POST Add Notes to Subscriber

Adicione uma nota interna ao assinante.

https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/add-notes

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`phone_number`	Número de telefone do assinante	String · Obrigatório
`note_text`	Texto da nota	String · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/subscriber/chat/add-notes' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'note_text=NOTE-TEXT'

Exemplo de resposta

{"status":"1","message":"Notes have been added successfully."}

API de Rótulos

GET/POST Label List

Liste os rótulos (etiquetas) cadastrados.

https://app.nexiyo.com.br/api/v1/whatsapp/label/list

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/label/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/label/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'

Exemplo de resposta

{"status":"1","message":[{"id":1,"label_name":"Your label name","status":"1"}]}

GET/POST Label Create

Crie um novo rótulo (etiqueta).

https://app.nexiyo.com.br/api/v1/whatsapp/label/create

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`phone_number_id`	Seu número de telefone do WhatsApp	String · Obrigatório
`label_name`	Nome do rótulo	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/label/create?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&label_name=LABEL-NAME

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/label/create' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'label_name=LABEL-NAME'

Exemplo de resposta

{"status":"1","message":"Label has been created successfully."}

API de Catálogo

GET/POST Catalog List

Liste os catálogos conectados à conta do WhatsApp.

https://app.nexiyo.com.br/api/v1/whatsapp/catalog/list

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/catalog/list?apiToken=API-KEY

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/catalog/list' \
-d 'apiToken=API-KEY'

Exemplo de resposta

{"status":true,"message":[{"catalog_id":"142926...","catalog_name":"The White","catalog_url":"https://..."}]}

POST Catalog Sync

Sincronize os produtos de um catálogo do WhatsApp.

https://app.nexiyo.com.br/api/v1/whatsapp/catalog/sync

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`whatsapp_catalog_id`	Seu ID de catálogo do WhatsApp	String · Obrigatório

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/catalog/sync' \
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID'

Exemplo de resposta

{"status":"1","message":"Catalog products have been synced successfully."}

GET/POST Catalog Order List

Liste os pedidos feitos através do catálogo.

https://app.nexiyo.com.br/api/v1/whatsapp/catalog/order/list

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`whatsapp_catalog_id`	Seu ID de catálogo do WhatsApp	String · Opcional

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=WHATSAPP-CATALOG-ID

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/catalog/order/list' \
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID'

Exemplo de resposta

{"status":"1","message":[{"order_unique_id":"1723...","cart_total":4300,"cart_currency":"USD","cart_status_raw":"Submitted"}]}

GET/POST Catalog Order Status Change

Altere o status de um pedido do catálogo.

https://app.nexiyo.com.br/api/v1/whatsapp/catalog/order/status-change

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`order_unique_id`	ID do pedido de catálogo	String · Obrigatório
`cart_status`	Aprovado, Concluído, Enviado, Entregue ou Reembolsado	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/whatsapp/catalog/order/status-change?apiToken=API-KEY&order_unique_id=ORDER-UNIQUE-ID&cart_status=CART-STATUS

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/whatsapp/catalog/order/status-change' \
-d 'apiToken=API-KEY' \
-d 'order_unique_id=ORDER-UNIQUE-ID' \
-d 'cart_status=CART-STATUS'

Exemplo de resposta

{"status":true,"message":"Cart status has been updated successfully"}

API de Usuário

GET/POST Get Direct Login URL

Gere uma URL de login única, segura e exclusiva para o usuário.

https://app.nexiyo.com.br/api/v1/user/get/direct-login-url

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`email`	E-mail do usuário	Email · Obrigatório
`name`	Nome do usuário	String · Opcional
`mobile`	Número de telefone do usuário	String · Opcional
`package_id`	ID do pacote (obrigatório para novo usuário)	Integer · Obrigatório
`expired_date`	Data de expiração do pacote, ex: 12/09/2026	String · Obrigatório
`status`	Ativo (1) ou inativo (0)	String · Opcional
`create_on_fail`	1 cria um novo usuário se não encontrado, 0 retorna erro	Boolean · Opcional

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/user/get/direct-login-url?apiToken=API-KEY&email=EMAIL&name=NAME&package_id=PACKAGE-ID&expired_date=EXPIRED-DATE&create_on_fail=1

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/user/get/direct-login-url' \
-d 'apiToken=API-KEY' \
-d 'email=EMAIL' \
-d 'name=NAME' \
-d 'package_id=PACKAGE-ID' \
-d 'expired_date=EXPIRED-DATE' \
-d 'create_on_fail=1'

Exemplo de resposta

{"status":"1","message":{"email":"user@dominio.com","login_url":"https://app.nexiyo.com.br/login","direct_login_url":"https://app.nexiyo.com.br/direct-login/xxxxxxxxxx"}}

GET/POST Get Direct Login URL (só novos usuários)

Cria o usuário caso ele não exista e retorna uma URL de login direto de uso único. Se já existir, retorna aviso de usuário existente.

https://app.nexiyo.com.br/api/v1/user/get/direct-login-url/only-new-users

Parâmetro	Descrição	Tipo
`apiToken`	Sua chave de API	String · Obrigatório
`email`	E-mail do usuário	Email · Obrigatório
`package_id`	ID do pacote	Integer · Obrigatório
`expired_date`	Data de validade do pacote, ex: 2026-05-05	String · Obrigatório

Exemplo de requisição GET

https://app.nexiyo.com.br/api/v1/user/get/direct-login-url/only-new-users?apiToken=API-KEY&email=EMAIL&package_id=PACKAGE-ID&expired_date=EXPIRED-DATE

Exemplo de requisição POST

curl -X POST \
'https://app.nexiyo.com.br/api/v1/user/get/direct-login-url/only-new-users' \
-d 'apiToken=API-KEY' \
-d 'email=EMAIL' \
-d 'package_id=PACKAGE-ID' \
-d 'expired_date=EXPIRED-DATE'

Exemplo de resposta

{"status":"1","message":{"email":"user@dominio.com","direct_login_url":"https://app.nexiyo.com.br/direct-login/xxxxxxxxxx"}}

Exemplo de resposta

{"status":"0","message":"User already existed"}

Conecte seus canais em uma experiência única.

Ferramentas para construir, integrar e crescer.

Obtenha sua chave de API e integre com a Nexiyo

WhatsApp API

API de Assinante

API de Rótulos

API de Catálogo

API de Usuário