Skip to main content
POST
Create a group

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Body

application/json
subject
string
required
Maximum string length: 128
description
string | null
Maximum string length: 2048
join_approval_mode
enum<string>
default:auto_approve
Available options:
auto_approve,
approval_required
phone_number_id
string | null
Maximum string length: 64
connection_uuid
string<uuid> | null

Response

Group created.

uuid
string<uuid>
provider_group_id
string | null
provider_request_id
string | null
subject
string
description
string | null
join_approval_mode
string | null
status
enum<string>

pending until Meta confirms creation; suspended when WhatsApp suspended the group.

Available options:
pending,
active,
failed,
suspended,
deleting,
deleted
total_participant_count
integer | null
connection_uuid
string<uuid>
phone_number_id
string
provider_created_at
string<date-time> | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
last_error
object | null

Meta's errors from the last failed create or settings change.

last_message_at
string<date-time> | null