Skip to main content
POST
/
session
/
{sessionId}
/
group
/
{jid}
/
send-invite
Send group invite
curl --request POST \
  --url https://api.zappaz.io/api/v1/session/{sessionId}/group/{jid}/send-invite \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "5519987465779",
  "message": "Join my group!"
}
'
{
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Token de usuário ou sessão, passado diretamente como uma string no cabeçalho 'Authorization'. O token de usuário tem escopo sobre todas as sessões pertencentes ao usuário. O token de sessão é limitado à própria sessão.

Path Parameters

​
sessionId
string
required

Identificador único da sessão

​
jid
string
required

Group identifier (JID)

Body

application/json
​
number
string
required

Phone number of the invitee

Example:

"5519987465779"

​
message
string
required

Message to send with the invite

Example:

"Join my group!"

Response

Group invite sent successfully

​
status
enum<string>
Available options:
success,
failed
​
data
object