WhatsApp API - Labels icon

WhatsApp API - Labels

Manage WhatsApp Business labels

Apply Label

AI-generated

Summary

Apply a specified label to a WhatsApp chat using the WhatsApp Business API.

Inputs

  • Session ID (required) — The WhatsApp session ID to identify the active WhatsApp session for the request.
  • Organization ID (required) — The organization identifier for multi-tenant access, allowing the label application within the specified organization context.
  • Label ID (required) — The unique identifier of the label to be applied to the chat.
  • Chat ID (required) — The WhatsApp chat ID to which the label will be applied.

Output shape

a list with a single JSON object representing the API response confirming the label application

The API returns a JSON response body confirming the label application; errors during execution will either throw or return an error object if 'Continue on Fail' is enabled.

Examples

Example 1: Apply an existing label to a specific WhatsApp chat

Specify active Session ID, Organization ID, the Label ID to assign, and the target Chat ID.

Discussion