API Reference

create group

post
https://waapi.app/api/v1/instances//client/action/create-group

Creates a new group with specified name and participants

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Instance ID of the client

Body Params
string
required
length ≥ 1

Name of the group to be created

groupParticipants
array of strings
required
length ≥ 1

Participants to add to the group, each as a phone number ID (<number>@c.us) or a LID (<lid>@lid). A LID is resolved to its phone number before the group is created; one that cannot be resolved is not added and is reported with statusCode 404. A person given more than once (also by number and by LID) is added once.

groupParticipants*
Responses

data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Group created successfully.

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance does not exist or does not belong to you

409

Conflict — instance is not ready

429

Too many requests — rate limit exceeded

Updated 8 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?