Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

Send a group invite link message

Sends a WhatsApp template message that contains the group invite link parameter.

This sends a message to an individual WhatsApp user. It does not send a message into the group conversation.

post/whatsapp/{businessPhoneNumber}/groups/inviteLink/messages

Path parameters

businessPhoneNumberstring required
Example:+16315551111

The WhatsApp business phone number in E.164 format.

Request body

tostring

The recipient's phone number in E.164 format. Required when recipient is not provided.

recipientstring

The recipient's WhatsApp Business-scoped user ID (BSUID) or parent BSUID. Required when to is not provided.

templateNamestring required

The name of the approved WhatsApp template.

languageCodestring required

The template language code.

Response

The message request is successfully accepted.

idstring required

Unique ID of the message.

wamidstring

The original message ID on WhatsApp's platform.

wabaIdstring required

WhatsApp Business Account ID.

fromstring required

The sender's phone number in E.164 format.

tostring

The recipient's phone number in E.164 format.

recipientstring

The recipient value submitted in the request when a BSUID or parent BSUID was used.

recipientUserIdstring

The recipient's WhatsApp Business-scoped user ID (BSUID).

toUserIdstring

Alias of recipientUserId kept for compatibility.

parentRecipientUserIdstring

The recipient's parent WhatsApp Business-scoped user ID.

toParentUserIdstring

Alias of parentRecipientUserId kept for compatibility.

type'template' | 'text' | 'image' | 'audio' | 'video' | 'document' | 'sticker' | 'location' | 'interactive' | 'contacts' | 'reaction'

WhatsApp outbound message type. See also WhatsApp messages.

externalIdstring

A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.

status'accepted' | 'failed' | 'sent' | 'delivered' | 'read'

WhatsApp message status. One of accepted, failed, sent, delivered, read.

  • accepted: The messaging request is accepted by our system.
  • failed: A message sent by your business failed to send.
  • sent: A message sent by your business is in transit within WhatsApp's systems.
  • delivered: A message sent by your business was delivered to the user's device.
  • read: A message sent by your business was read by the user.
errorCodestring

Error code when the message status is failed.

errorMessagestring

Error message when the message status is failed.

createTimestring date-time

The time at which this message is created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

updateTimestring date-time

The time at which this message is updated, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

sendTimestring date-time

The time at which this message status changed to sent, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

deliverTimestring date-time

The time at which this message status changed to delivered, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

readTimestring date-time

The time at which this message status changed to read, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

totalPricenumber double

Total price of this message. Note: It's only an estimated price when the status is accepted or sent. It becomes the final price after the message is delivered, i.e., the status is delivered or read.

currencystring

Price currency. ISO 4217 currency code.

regionCodestring

The region code of the recipient phone number.

pricingCategory'referral_conversion' | 'authentication' | 'authentication_international' | 'marketing' | 'marketing_lite' | 'utility' | 'service'

WhatsApp pricing category.

  • referral_conversion: Indicates a free entry point conversation.
  • authentication: Indicates the conversation was billed at authentication rate.
  • authentication_international: Indicates the conversation was conversation was billed at the authentication-international rate.
  • marketing: Indicates the conversation was billed at authentication rate.
  • marketing_lite: Indicates the conversation was billed at marketing-lite rate.
  • utility: Indicates the conversation was billed at utility rate.
  • service: Indicates the conversation was billed at service rate.

See also Conversation-Based Pricing.

pricingModel'PMP' | 'CBP'

WhatsApp pricing model.

  • PMP: Per-message pricing applies.
  • CBP: Conversation-based pricing applies.
pricingType'regular' | 'free_customer_service' | 'free_entry_point'

WhatsApp pricing type. This field is only available in PMP (Per-Message Pricing) mode.

  • regular: Indicates the message is billable.
  • free_customer_service: Indicates the message is free because it was either a utility template message or non-template message sent within a customer service window.
  • free_entry_point: Indicates the message is free because it is part of a free-entry point conversation.
bizTypestring

This can be either empty or one of whatsapp, or verify. Defaults to whatsapp.

  • whatsapp: Indicates that the message is sent via the WhatsApp product.
  • verify: Indicates that the message is sent via the Verify product.
verificationIdstring

The verification ID. Included only when bizType is verify.