Create a group
Creates a new WhatsApp group from one of your lines, with the people you name in it. The line that creates the group is its admin.
The group is ready to use as soon as this returns. Dial records it
before responding, so its id works as groupId on Send a message
straight away, and it appears in List groups. There is no event for a
group you created — the response is the confirmation.
Not everyone you name is always added. WhatsApp lets people choose
who may add them to groups, so a participant can be refused while the
group is still created with everyone else. Those participants come back
in notAdded and are not in the group; reason: "privacy_restricted"
means their settings only allow their contacts to add them. Dial does
not retry them or send them an invite.
The group gets WhatsApp’s ordinary new-group settings: every member may send messages and edit the group’s info. One group per request; there is no description, picture, or invite link.
A 504 does not mean the group wasn’t created. When the line
doesn’t confirm the group in time, the group may still exist. Check List
groups before trying again — a blind retry can create a duplicate group.
Authentication
Your Dial API key, sent as Authorization: Bearer sk_live_...
Request
The group’s name (its subject), as members see it.
The people to add, as E.164 numbers. Duplicates are ignored. The creating line’s own number is rejected with 400 — the line is in the group already, as its admin.
The line that creates the group, in E.164 format, or its nickname. It becomes the group’s admin. Provide at most one of fromNumber or fromNumberId; with neither, your primary number creates the group.
ID of the Dial number that creates the group (see List phone numbers). Alternative to fromNumber — provide at most one of the two.
Response
A group conversation — a conversation that is not a phone number, and so has an ID of its own. Address it with groupId when sending, and filter for it on List messages. Groups exist on WhatsApp lines and iMessage numbers.