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 Contact

AI-generated

Summary

Sends a contact profile to a specified recipient WhatsApp number

Inputs

  • phone (required) — Recipient phone number in international format (digits only, e.g., 5511999999999)
  • contactName (required) — Name of the contact to be shared
  • contactPhone (required) — Phone number of the contact to be shared (country code + area code + number)
  • contactBusinessDescription — Optional short description about the contact (not shown on WhatsApp Web)
  • delayMessage — Delay in seconds before sending (1‑15, default 0 for immediate)

Output shape

JSON object representing the API response (typically includes status, message ID, etc.)

No pagination; optional fields may be omitted; errors are thrown as NodeOperationError

Examples

Example 1: Send a contact to a new recipient with a 2‑second delay

phone: 5511999999999, contactName: John Doe, contactPhone: 5511888888888, contactBusinessDescription: Acme Corp, delayMessage: 2

Example 2: Send a contact without business description and immediately

phone: 5511999999999, contactName: Jane Smith, contactPhone: 5511777777777, contactBusinessDescription: (empty), delayMessage: 0

Example 3: Send a contact to a recipient with maximum allowed delay (15 seconds)

phone: 5511999999999, contactName: Alice, contactPhone: 5511666666666, contactBusinessDescription: Retail, delayMessage: 15

Links

Discussion