vértice
Produto Preços Painel
Mensagens

Compartilha convite de canal

Compartilha a mensagem de convite.

API key Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/messages/newsletter-admin-invite" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"to":"5511999999999","newsletterJid":"123456789@newsletter","newsletterName":"Canal","inviteExpiration":2000000000}'
POST /instances/{id}/messages/newsletter-admin-invite
API key
Entenda

Conceituação

Compartilha a mensagem de convite. Não concede privilégios nem substitui uma autorização válida no canal.

A operação exige que a instância esteja conectada ao WhatsApp. Caso o socket esteja desconectado, a API responde 409 not_connected.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

Body

to string opcional

Telefone com DDI e DDD, ou JID de grupo terminando em @g.us.

newsletterJid string opcional

Campo newsletterJid do corpo JSON.

newsletterName string opcional

Campo newsletterName do corpo JSON.

inviteExpiration integer opcional

Campo inviteExpiration do corpo JSON.

Payload

Request Body

{
  "to": "5511999999999",
  "newsletterJid": "123456789@newsletter",
  "newsletterName": "Canal",
  "inviteExpiration": 2000000000
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.
409 Instância não conectada ou conflito de estado.