Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Path Parameters

instanceId
string
required

Body

application/json
to
string[]
required

Números com DDI que receberão os links (ex.: 5511999999999)

Minimum array length: 1
groups
string[]

JIDs dos grupos cujo link será enviado. Um ou mais.

Required array length: 1 - 500 elements
Pattern: ^\d+@g\.us$
description
string

Text enviado com o convite (optional)

from
string

Remetente WhatsApp: id da instância, id ou nome do pool, telefone E.164 ou nome da instância.

Response

data.results: um item por grupo. Sucesso: groupJid, success: true, data.send, data.inviteUrl. Falha: groupJid, success: false, error.

success
boolean
Example:

true

data
object