Create a contact

client.Contact.New(ctx, body) (*ContactCreateResponse, error)

POST/v1/contacts

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 list filtering to check if a record exists before creating.

Required scope: contacts:create

Rate limit category: Write

ParametersExpand Collapse

body ContactNewParams

Fields param.Field[map[string, ContactNewParamsFieldUnion]]

Field values for the new contact. System fields use a $ prefix (e.g. $email, $name); custom attributes use their bare slug. Note: $name is an object { firstName, lastName }, not a plain string. Call the definitions endpoint to discover available fields and their types. See Fields and relationships for value type details.

map[string, ContactNewParamsFieldUnion]

One of the following:

string

float64

bool

type ContactNewParamsFieldArray []string

type ContactNewParamsFieldAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactNewParamsFieldFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

Relationships param.Field[map[string, ContactNewParamsRelationshipUnion]]Optional

Relationships to set on the new contact. System relationships use a $ prefix (e.g. $account); custom relationships use their bare slug. Each value is a single entity ID or an array of IDs. Call the definitions endpoint to list available relationship keys.

map[string, ContactNewParamsRelationshipUnion]

One of the following:

string

type ContactNewParamsRelationshipArray []string

ReturnsExpand Collapse

type ContactCreateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactCreateResponseField]

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

Value ContactCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactCreateResponseFieldValueArray []string

type ContactCreateResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ContactCreateResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ContactCreateResponseFieldValueTypeAddress ContactCreateResponseFieldValueType = "ADDRESS"

const ContactCreateResponseFieldValueTypeCheckbox ContactCreateResponseFieldValueType = "CHECKBOX"

const ContactCreateResponseFieldValueTypeCurrency ContactCreateResponseFieldValueType = "CURRENCY"

const ContactCreateResponseFieldValueTypeDatetime ContactCreateResponseFieldValueType = "DATETIME"

const ContactCreateResponseFieldValueTypeEmail ContactCreateResponseFieldValueType = "EMAIL"

const ContactCreateResponseFieldValueTypeFullName ContactCreateResponseFieldValueType = "FULL_NAME"

const ContactCreateResponseFieldValueTypeMarkdown ContactCreateResponseFieldValueType = "MARKDOWN"

const ContactCreateResponseFieldValueTypeMultiSelect ContactCreateResponseFieldValueType = "MULTI_SELECT"

const ContactCreateResponseFieldValueTypeNumber ContactCreateResponseFieldValueType = "NUMBER"

const ContactCreateResponseFieldValueTypeSingleSelect ContactCreateResponseFieldValueType = "SINGLE_SELECT"

const ContactCreateResponseFieldValueTypeSocialHandle ContactCreateResponseFieldValueType = "SOCIAL_HANDLE"

const ContactCreateResponseFieldValueTypeTelephone ContactCreateResponseFieldValueType = "TELEPHONE"

const ContactCreateResponseFieldValueTypeText ContactCreateResponseFieldValueType = "TEXT"

const ContactCreateResponseFieldValueTypeURL ContactCreateResponseFieldValueType = "URL"

HTTPLink string

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

Relationships map[string, ContactCreateResponseRelationship]

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

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

UpdatedAt string

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

ExternalID stringOptional

External identifier for the entity, or null if unset.

Create a contact

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  contactCreateResponse, err := client.Contact.New(context.TODO(), githubcomlightfldlightfieldgo.ContactNewParams{
    Fields: map[string]githubcomlightfldlightfieldgo.ContactNewParamsFieldUnion{
    "foo": githubcomlightfldlightfieldgo.ContactNewParamsFieldUnion{
      OfString: githubcomlightfldlightfieldgo.String("string"),
    },
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", contactCreateResponse.ID)
}

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}

Returns Examples

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}