PlunkPlunk
Concepts

Contacts

Manage and organize your contacts effectively

Contacts in Plunk represent an individual email recipient. Each contact has an identifier and is linked to an email address.

Adding contacts

Contacts can be added to your Plunk project in several ways:

  • Using /v1/track, when tracking an event for a contact that does not yet exist, Plunk will automatically create it.
  • Using /contacts, to create a single contact.
  • Import through CSV
  • Manually through the dashboard

Contact Data

You can associate custom data with each contact using key-value pairs. This data can be used for segmentation and personalization.

Data types

Contact data types are inferred based on the value provided:

TypeDescription
StringAny text value
NumberNumeric values, including integers and floats
BooleanTrue or false values
DateDate values in ISO 8601 format

Default data type

If you accidentally mix data types for a specific key, Plunk will default to treating the value as a string.

Reserved keys

Certain keys are reserved by the system and automatically set by Plunk:

KeyDescription
emailThe contact's email address
createdAtTimestamp of when the contact was created
updatedAtTimestamp of the last update to the contact
subscribedBoolean indicating if the contact is globally subscribed or not

Special keys

KeyDescription
localeThe contact's preferred locale in ISO 639 (e.g. 'en', 'fr', 'es'). Specifying the locale field on a contact will override the project-wide locale for contact-facing pages and email footers