v1

latestSwagger 2.0Apache 2.02026-08-06303655.6 KB

contacts

Create a contact

Creates a contact for the authenticated account, or returns the existing active contact if one already exists for the given email. Optionally adds the contact to a list and registers an external system identifier. Both source_identifier and system must be provided together to create an external identifier.

post/contacts

Request body

emailstring email required

first_namestring

last_namestring

sourcestring

Origin of the contact (e.g. 'hubspot', 'csv')

can_emailboolean

Sets the contact's emailability. Applied whether this POST creates a new contact or matches an existing active contact by email. Defaults to true on creation when omitted.

list_idinteger

Add the contact to this list immediately

optionsobject

Arbitrary key-value attributes stored on the contact. Persisted only when this POST creates a new contact; ignored when an active contact already exists for the email (same as first_name/last_name/source). Use PUT /contacts/{id} to merge options into an existing contact.

systemstring

External system name (e.g. 'hubspot'). Must be provided together with identifier to create an external identifier record.

identifierstring

The contact's ID in the external system. Must be provided together with system.

system_identifierstring

Optional sub-system identifier (e.g. a HubSpot portal ID).

Response

Contact created (or existing contact returned)