Skip to main content
POST
Manage participants

Authorizations

Authorization
string
header
required

Instance token (zpfy_inst_...) — sends messages.

Body

application/json
id
string
required

the group id (returned by GET /groups).

Example:

"120363012345678901"

participants
string[]
required

Participants to add, remove or promote (phones in E.164).

Minimum array length: 1

Recipient: a phone in E.164 (with or without +, spaces or formatting, e.g. 5511999998888 or +55 11 99999-8888) or a group id. To send to a group, use the group id (from GET /groups).

Example:
action
enum<string>
required

ADD/REMOVE = membership; PROMOTE/DEMOTE = admin role.

Available options:
ADD,
REMOVE,
PROMOTE,
DEMOTE

Response

Action performed.

data
object