Groundhogg icon

Groundhogg

Interact with the Groundhogg CRM API

Contact → Create

AI-generated

Summary

Create or update a contact in Groundhogg by providing an email address along with optional personal details, meta fields, tags, and custom fields. If the email already exists, the contact is updated (upsert behavior).

Inputs

  • Email (required) — The contact's email address; acts as the unique identifier for creating or updating the contact.
  • First Name — The first name of the contact.
  • Last Name — The last name of the contact.
  • Phone — Primary phone number stored as the contact's 'primary_phone' meta field.
  • Owner Name or ID — WordPress user assigned as contact owner; can select from loaded site users or provide an ID via expression.
  • Additional Fields — Additional properties including optin status and tags (comma-separated IDs or names).
  • Meta Fields — Standard contact meta information such as birthday (auto-normalized date), city, company name, country, job title, lead source, mobile phone, notes, postal/ZIP code, region, and street addresses.
  • Custom Fields — Groundhogg custom fields set by field name or ID and corresponding values; supports multiple custom fields.

Output shape

a single JSON object representing the created or updated contact record.

Tags provided are parsed into IDs or names and applied. Birthday field input is normalized to YYYY-MM-DD format. If the provided email matches an existing contact, that contact is updated; otherwise, a new contact is created.

Examples

Example 1: Create a new contact with email, name, and tags

Set Email to an email address, optionally fill First Name and Last Name, and specify comma-separated Tags in Additional Fields.

Example 2: Update an existing contact by email with meta fields

Provide existing contact's Email and fill in Meta Fields or Custom Fields to update, such as birthday or company name.

Links

Discussion