Assign Custom Fields and/or Tags to WA Group

Add tags and/or set chat-level custom fields on a WhatsApp group chat.

Before you call

  • groupId is required: the WhatsApp group's ID.
  • Send tags and/or customFields. Each tag is up to 50 characters; each custom field value up to 3000 characters.
  • To create a custom field that does not exist yet, you need permission to manage custom fields.

How it works

  • Tags that do not exist are created and added to the group chat. Existing tags stay.
  • Custom fields are matched by name and set on the group chat.
  • Results are per item: tags.added, customFields.added and customFields.errored (with a reason each).
  • Returns 404 if the group, or its chat, is not found.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

WhatsApp group ID (client custom group ID)

tags
array of strings

Array of tags to assign to the group chat

tags
customFields
array of objects

Array of chat-level custom fields to assign to the group

customFields
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json