PeachInstall

Summary

Creates a Peach contact, or updates the existing one, keyed by phone number. It sends a POST to /api/v1/contacts with the contact's details.

Inputs

• Phone Number (required) — Contact's phone number, including country code. Sent as phone_number.
• Name — Contact's name.
• Email — Contact's email address.
• Timezone — Contact's timezone, e.g. Asia/Kolkata.
• Opted Out — Boolean (default false). Marks whether the contact has opted out of messages.
• Communication Preference — One of Allow Everything (default), Disallow Marketing, Disallow Automated Messaging, or Mute All.
• Metadata — JSON object of custom metadata (default {}).
• Tags (Comma Separated) — Comma-separated tags. The value is split on commas with no trimming, so avoid spaces after commas. An empty value is sent as a list with one empty string.
• Request Options — Node setting for batching (items per batch, interval), ignoring SSL errors, a proxy, and a timeout (default 10000 ms).

Output shape

The JSON response from the Peach API for the created or updated contact, one result per input item.

The source doesn't define the response fields, so they depend on the Peach API. Every field is always sent, even when left blank. A blank Name, Email or Timezone is sent as an empty string and may overwrite existing values. Opted Out and Communication Preference are also always sent, so their defaults may overwrite existing settings. Requires Peach API credentials.

Examples

Example 1: Sync a new CRM lead into Peach

Phone Number = {{$json.phone}}, Name = {{$json.name}}, Email = {{$json.email}}, Tags = 'lead,webinar'.

Example 2: Record an unsubscribe request

Phone Number = {{$json.phone}}, Opted Out = true, Communication Preference = Mute All.

Links

• n8n community nodes installation guide