Skip to main content
PATCH
Update a group

Authorizations

Authorization
string
header
required

Authorization: Bearer hmok_... API key or a dashboard session token

Headers

Idempotency-Key
string

Optional. Send the same key when retrying the same request: a completed request is replayed (same status and body, Idempotent-Replayed: true) instead of running twice. Keys are scoped to your organization for 24 hours. 409 IDEMPOTENCY_KEY_REUSED: the key was used for a different request. 409 IDEMPOTENCY_IN_PROGRESS: the first request is still running. 409 IDEMPOTENCY_OUTCOME_UNKNOWN: the first attempt may have reached the channel; check it before retrying with a new key. Without the header, delivery is at-least-once.

Pattern: ^[\x21-\x7E]{1,255}$

Path Parameters

ch
string
required

ch_ channel id

groupId
string
required

WhatsApp group id, as returned by the list and by whatsapp.group.updated events.

Pattern: ^(?!\d+$)[A-Za-z0-9+=_-]{1,256}$

Body

application/json
subject
string
required
Required string length: 1 - 128
description
string
Maximum string length: 2048

Response

Accepted

channelId
string
required
requestId
string | null
required

Matches the requestId on the whatsapp.group.updated event that reports the outcome