Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-text
Mention group
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-text \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "groupMentioned": [
    {
      "phone": "<string>",
      "subject": "<string>"
    }
  ]
}
'

​
Overview

This method is responsible for mentioning groups related to a community. The system restricts mentions to groups within the same community structure.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Group ID where the mention will be sent
​
message
string
required
Text to be sent (must contain @ with the group ID)
​
groupMentioned
array
required
Array with the data of groups to be mentioned

​
Optional

​
delayMessage
number
Delay added to the message. You can choose between a range of 1 to 15 sec. The default delay if not provided is 1 to 3 sec

​
Request Body

{
  "phone": "5511999999999-group",
  "message": "Welcome to *Z-API group* @1203634230225498-group",
  "groupMentioned": [
    {
      "phone": "1203634230225498-group",
      "subject": "Z-API subgroup"
    }
  ]
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.