v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Create a contact

Creates a new contact record.

After creation, Lightfield automatically enriches the contact in the background.

Supports idempotency via the Idempotency-Key header.

To avoid duplicates, we recommend a find-or-create pattern — use <u>list filtering</u> to check if a record exists before creating.

Required scope: contacts:create

Rate limit category: Write

post/v1/contacts

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Request body

Response

OK

idstring required

Unique identifier for the entity.

createdAtstring required

ISO 8601 timestamp of when the entity was created.

updatedAtstring nullable required

ISO 8601 timestamp of when the entity was last updated, or null.

httpLinkstring nullable required

URL to view the entity in the Lightfield web app, or null.

externalIdstring nullable

External identifier for the entity, or null if unset.

fieldsobject required

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

relationshipsobject required

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).