Skip to main content
POST
/
groups
/
join
/
invite
Join a group via invite message
curl --request POST \
  --url https://api.wsapi.chat/groups/join/invite \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "groupId": "<string>",
  "inviterId": "<string>",
  "code": "<string>",
  "expiration": 123
}
'
{
  "status": 400,
  "detail": "invalid request body"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Body

application/json
​
groupId
string
required
​
inviterId
string
required
​
code
string
required
​
expiration
integer<int64>

Response

Joined group