Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Message → Send a Link

AI-generated

Summary

Send a link message

Inputs

  • phone (required) — Contact number (or group ID) in international format, digits only. Example: 5511999999999.
  • message (required) — Message text to be sent
  • linkImage (required) — Image URL that will be displayed in the shared link
  • linkUrl (required) — Website URL to be shared
  • linkTitle (required) — Title that will be displayed in the shared link
  • linkDescription (required) — Description that will be displayed in the shared link
  • delayMessage — Delay in seconds before sending the message. Z-API recommends between 1 and 15 seconds. If 0, uses the API default behavior.

Output shape

object (API response)

Typically contains success information and possibly a message ID; structure may vary by Z‑API version.

Examples

Example 1: Send a promotional link to a client

Phone: 5511999999999; Message: 'Check out our offer'; Link URL: https://example.com/offer; Link Title: 'Special Offer'; Link Description: 'Limited time discount'; Delay: 0

Example 2: Send a link with a delay to a group

Phone: 5511999999999; Message: 'Please review'; Link URL: https://example.com/review; Link Title: 'Review Page'; Link Description: 'Detailed review'; Delay: 5

Links

Discussion