# Contact ## Get contact field definitions `$ lightfield contact definitions` **get** `/v1/contacts/definitions` Returns the schema for all field and relationship definitions available on contacts, including both system-defined and custom fields. Useful for understanding the shape of contact data before creating or updating records. See [Fields and relationships](/using-the-api/fields-and-relationships/) for more details. **[Required scope](/using-the-api/scopes/):** `contacts:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Returns - `contact_definitions_response: object { fieldDefinitions, objectType, relationshipDefinitions }` - `fieldDefinitions: map[object { description, label, typeConfiguration, 3 more } ]` Map of field keys to their definitions, including both system and custom fields. - `description: string` Description of the field, or null. - `label: string` Human-readable display name of the field. - `typeConfiguration: object { currency, handleService, multipleValues, 2 more }` Type-specific configuration (e.g. select options, currency code). - `currency: optional string` ISO 4217 3-letter currency code. - `handleService: optional "TWITTER" or "LINKEDIN" or "FACEBOOK" or "INSTAGRAM"` Social platform associated with this handle field. - `"TWITTER"` - `"LINKEDIN"` - `"FACEBOOK"` - `"INSTAGRAM"` - `multipleValues: optional boolean` Whether this field accepts multiple values. - `options: optional array of object { id, label, description }` Available options for select fields. - `id: string` Unique identifier of the select option. - `label: string` Human-readable display name of the option. - `description: optional string` Description of the option, or null. - `unique: optional boolean` Whether values for this field must be unique. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` Data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `id: optional string` Unique identifier of the field definition. - `readOnly: optional boolean` `true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields. - `objectType: string` The object type these definitions belong to (e.g. `account`). - `relationshipDefinitions: map[object { cardinality, description, label, 2 more } ]` Map of relationship keys to their definitions. - `cardinality: "HAS_ONE" or "HAS_MANY"` Whether this is a `has_one` or `has_many` relationship. - `"HAS_ONE"` - `"HAS_MANY"` - `description: string` Description of the relationship, or null. - `label: string` Human-readable display name of the relationship. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `id: optional string` Unique identifier of the relationship definition. ### Example ```cli lightfield contact definitions \ --api-key 'My API Key' ``` #### Response ```json { "fieldDefinitions": { "foo": { "description": "description", "label": "label", "typeConfiguration": { "currency": "currency", "handleService": "TWITTER", "multipleValues": true, "options": [ { "id": "id", "label": "label", "description": "description" } ], "unique": true }, "valueType": "ADDRESS", "id": "id", "readOnly": true } }, "objectType": "objectType", "relationshipDefinitions": { "foo": { "cardinality": "HAS_ONE", "description": "description", "label": "label", "objectType": "objectType", "id": "id" } } } ``` ## Create a contact `$ lightfield contact create` **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](/using-the-api/list-endpoints/#filtering) to check if a record exists before creating. **[Required scope](/using-the-api/scopes/):** `contacts:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `--fields: object { "$email", "$name", "$profilePhotoUrl" }` 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](/api/resources/contact/methods/definitions) to discover available fields and their types. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `--relationships: optional object { "$account" }` 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](/api/resources/contact/methods/definitions) to list available relationship keys. ### Returns - `contact_create_response: object { id, createdAt, fields, 4 more }` - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset. ### Example ```cli lightfield contact create \ --api-key 'My API Key' \ --fields '{}' ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Update a contact `$ lightfield contact update` **post** `/v1/contacts/{id}` Updates an existing contact by ID. Only included fields and relationships are modified. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `contacts:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `--id: string` Unique identifier of the contact to update. - `--fields: optional object { "$email", "$name", "$profilePhotoUrl" }` Field values to update — only provided fields are modified; omitted fields are left unchanged. System fields use a `$` prefix (e.g. `$email`); custom attributes use their bare slug. Note: `$name` is an object `{ firstName, lastName }`, not a plain string. Call the [definitions endpoint](/api/resources/contact/methods/definitions) for available fields and types. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `--relationships: optional object { "$account" }` Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`). Each value is an operation object with `add`, `remove`, or `replace`. ### Returns - `contact_update_response: object { id, createdAt, fields, 4 more }` - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset. ### Example ```cli lightfield contact update \ --api-key 'My API Key' \ --id id ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Retrieve a contact `$ lightfield contact retrieve` **get** `/v1/contacts/{id}` Retrieves a single contact by its ID. **[Required scope](/using-the-api/scopes/):** `contacts:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `--id: string` Unique identifier of the contact to retrieve. ### Returns - `contact_retrieve_response: object { id, createdAt, fields, 4 more }` - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset. ### Example ```cli lightfield contact retrieve \ --api-key 'My API Key' \ --id id ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## List contacts `$ lightfield contact list` **get** `/v1/contacts` Returns a paginated list of contacts. Use `offset` and `limit` to paginate through results, and `$field` query parameters to filter. See [List endpoints](/using-the-api/list-endpoints/) for more information about [pagination](/using-the-api/list-endpoints/#pagination) and [filtering](/using-the-api/list-endpoints/#filtering). **[Required scope](/using-the-api/scopes/):** `contacts:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `--limit: optional number` Maximum number of records to return. Defaults to 25, maximum 25. - `--offset: optional number` Number of records to skip for pagination. Defaults to 0. ### Returns - `contact_list_response: object { data, object, totalCount }` - `data: array of object { id, createdAt, fields, 4 more }` Array of entity objects for the current page. - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset. - `object: string` The object type, always `"list"`. - `totalCount: number` Total number of entities matching the query. ### Example ```cli lightfield contact list \ --api-key 'My API Key' ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ], "object": "object", "totalCount": 0 } ``` ## Domain Types ### Contact Create Response - `contact_create_response: object { id, createdAt, fields, 4 more }` - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset. ### Contact Definitions Response - `contact_definitions_response: object { fieldDefinitions, objectType, relationshipDefinitions }` - `fieldDefinitions: map[object { description, label, typeConfiguration, 3 more } ]` Map of field keys to their definitions, including both system and custom fields. - `description: string` Description of the field, or null. - `label: string` Human-readable display name of the field. - `typeConfiguration: object { currency, handleService, multipleValues, 2 more }` Type-specific configuration (e.g. select options, currency code). - `currency: optional string` ISO 4217 3-letter currency code. - `handleService: optional "TWITTER" or "LINKEDIN" or "FACEBOOK" or "INSTAGRAM"` Social platform associated with this handle field. - `"TWITTER"` - `"LINKEDIN"` - `"FACEBOOK"` - `"INSTAGRAM"` - `multipleValues: optional boolean` Whether this field accepts multiple values. - `options: optional array of object { id, label, description }` Available options for select fields. - `id: string` Unique identifier of the select option. - `label: string` Human-readable display name of the option. - `description: optional string` Description of the option, or null. - `unique: optional boolean` Whether values for this field must be unique. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` Data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `id: optional string` Unique identifier of the field definition. - `readOnly: optional boolean` `true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields. - `objectType: string` The object type these definitions belong to (e.g. `account`). - `relationshipDefinitions: map[object { cardinality, description, label, 2 more } ]` Map of relationship keys to their definitions. - `cardinality: "HAS_ONE" or "HAS_MANY"` Whether this is a `has_one` or `has_many` relationship. - `"HAS_ONE"` - `"HAS_MANY"` - `description: string` Description of the relationship, or null. - `label: string` Human-readable display name of the relationship. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `id: optional string` Unique identifier of the relationship definition. ### Contact List Response - `contact_list_response: object { data, object, totalCount }` - `data: array of object { id, createdAt, fields, 4 more }` Array of entity objects for the current page. - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset. - `object: string` The object type, always `"list"`. - `totalCount: number` Total number of entities matching the query. ### Contact Retrieve Response - `contact_retrieve_response: object { id, createdAt, fields, 4 more }` - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset. ### Contact Update Response - `contact_update_response: object { id, createdAt, fields, 4 more }` - `id: string` Unique identifier for the entity. - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: map[object { value, valueType } ]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string or number or boolean or 3 more` The field value, or null if unset. - `union_member_0: string` - `union_member_1: number` - `union_member_2: boolean` - `union_member_3: array of string` - `Address: object { city, country, latitude, 5 more }` - `city: optional string` City name. - `country: optional string` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: optional number` Latitude coordinate. - `longitude: optional number` Longitude coordinate. - `postalCode: optional string` Postal or ZIP code. - `state: optional string` State or province. - `street: optional string` Street address line 1. - `street2: optional string` Street address line 2. - `FullName: object { firstName, lastName }` - `firstName: optional string` The contact's first name. - `lastName: optional string` The contact's last name. - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string` URL to view the entity in the Lightfield web app, or null. - `relationships: map[object { cardinality, objectType, values } ]` 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: array of string` IDs of the related entities. - `updatedAt: string` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId: optional string` External identifier for the entity, or null if unset.