Skip to content

Contact

Contacts represent individual people in Lightfield. Contacts can be associated with one or more accounts.

Get contact field definitions
client.Contact.Definitions(ctx, query) (*ContactDefinitionsResponse, error)
GET/v1/contacts/definitions
Get field value history
client.Contact.FieldHistory(ctx, fieldKey, params) (*ContactFieldHistoryResponse, error)
GET/v1/contacts/{id}/fields/{fieldKey}/history
Create a contact
client.Contact.New(ctx, body) (*ContactCreateResponse, error)
POST/v1/contacts
Update a contact
client.Contact.Update(ctx, id, body) (*ContactUpdateResponse, error)
POST/v1/contacts/{id}
Retrieve a contact
client.Contact.Get(ctx, id) (*ContactRetrieveResponseUnion, error)
GET/v1/contacts/{id}
List contacts
client.Contact.List(ctx, query) (*ContactListResponse, error)
GET/v1/contacts
Delete a contact
client.Contact.Delete(ctx, id, body) (*ContactDeleteResponse, error)
DELETE/v1/contacts/{id}
Restore a contact
client.Contact.Restore(ctx, id, body) (*ContactRestoreResponse, error)
POST/v1/contacts/{id}/restore
ModelsExpand 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 ContactCreateResponseFieldValueTypeDate ContactCreateResponseFieldValueType = "DATE"
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"
const ContactCreateResponseFieldValueTypeHTML ContactCreateResponseFieldValueType = "HTML"
Relationships map[string, ContactCreateResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions ContactCreateResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ContactCreateResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactCreateResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ContactCreateResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ContactCreateResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactCreateResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ContactCreateResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.

type ContactDefinitionsResponse struct{…}
FieldDefinitions map[string, ContactDefinitionsResponseFieldDefinition]

Map of field keys to their definitions, including both system and custom fields.

Archived bool

Whether the field definition is archived.

ArchivedAt Time

When the field definition was archived, or null if active.

formatdate-time
Description string

Description of the field, or null.

Label string

Human-readable display name of the field.

TypeConfiguration ContactDefinitionsResponseFieldDefinitionTypeConfiguration

Type-specific configuration (e.g. select options, currency code). A key the field type does not support is absent; a supported key with nothing set is null.

Currency stringOptional

ISO 4217 3-letter currency code. Present on CURRENCY fields, absent on every other type.

DecimalPlaces int64Optional

Number of decimal places values carry, or null when none is set. Present on NUMBER and CURRENCY fields, absent on every other type.

minimum-9007199254740991
maximum9007199254740991
HandleService stringOptional

Social platform associated with this handle field, or null when none is set. Present on SOCIAL_HANDLE fields, absent on every other type.

One of the following:
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram ContactDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"
MultipleValues boolOptional

Whether this field accepts multiple values. Present on EMAIL, TELEPHONE and URL fields, absent on every other type.

Options []ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

Available options. Always present on SINGLE_SELECT and MULTI_SELECT fields, as an empty list when there are none. Absent on every other type.

ID string

Unique identifier of the select option.

Label string

Human-readable display name of the option.

Category stringOptional

Lifecycle group of the option, in-progress (ACTIVE) or done (COMPLETED), or null when none is set. Absent on selects whose options are not grouped.

One of the following:
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryActive ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "ACTIVE"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryCompleted ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "COMPLETED"
Color stringOptional

Color the option is displayed in, GRAY when none was chosen. Absent on selects whose options take no color.

One of the following:
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorRed ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "RED"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorOrange ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "ORANGE"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorYellow ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "YELLOW"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorLime ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "LIME"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGreen ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GREEN"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorBlue ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "BLUE"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorIndigo ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "INDIGO"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorPurple ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "PURPLE"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorCopper ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "COPPER"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGray ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GRAY"
Description stringOptional

Description of the option, or null.

ForecastPercentage float64Optional

Forecast weighting of the option from 0 to 100, or null when none is set. Absent on selects whose options take no forecast.

Icon stringOptional

Icon the option is displayed with, or null when none is set. Present only on $stage.

One of the following:
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconBacklog ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "BACKLOG"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconQualification ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "QUALIFICATION"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconDiscovery ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "DISCOVERY"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconActive ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "ACTIVE"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconNegotiation ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "NEGOTIATION"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedWon ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_WON"
const ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedLost ContactDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_LOST"
ParentID stringOptional

For a dependent select, the ID of the option in the parent field named by typeConfiguration.parentFieldKey that owns this option. Absent for ordinary selects.

ParentFieldKey stringOptional

For a dependent select, the field key whose selected option determines which of this field’s options apply. Absent for ordinary selects.

Unique boolOptional

Whether values for this field must be unique, or null when not set. Present on EMAIL, TELEPHONE, URL and SOCIAL_HANDLE fields, absent on every other type.

ValueType string

Data type of the field.

One of the following:
const ContactDefinitionsResponseFieldDefinitionValueTypeAddress ContactDefinitionsResponseFieldDefinitionValueType = "ADDRESS"
const ContactDefinitionsResponseFieldDefinitionValueTypeCheckbox ContactDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"
const ContactDefinitionsResponseFieldDefinitionValueTypeCurrency ContactDefinitionsResponseFieldDefinitionValueType = "CURRENCY"
const ContactDefinitionsResponseFieldDefinitionValueTypeDate ContactDefinitionsResponseFieldDefinitionValueType = "DATE"
const ContactDefinitionsResponseFieldDefinitionValueTypeDatetime ContactDefinitionsResponseFieldDefinitionValueType = "DATETIME"
const ContactDefinitionsResponseFieldDefinitionValueTypeEmail ContactDefinitionsResponseFieldDefinitionValueType = "EMAIL"
const ContactDefinitionsResponseFieldDefinitionValueTypeFullName ContactDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"
const ContactDefinitionsResponseFieldDefinitionValueTypeMarkdown ContactDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"
const ContactDefinitionsResponseFieldDefinitionValueTypeMultiSelect ContactDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"
const ContactDefinitionsResponseFieldDefinitionValueTypeNumber ContactDefinitionsResponseFieldDefinitionValueType = "NUMBER"
const ContactDefinitionsResponseFieldDefinitionValueTypeSingleSelect ContactDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"
const ContactDefinitionsResponseFieldDefinitionValueTypeSocialHandle ContactDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"
const ContactDefinitionsResponseFieldDefinitionValueTypeTelephone ContactDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"
const ContactDefinitionsResponseFieldDefinitionValueTypeText ContactDefinitionsResponseFieldDefinitionValueType = "TEXT"
const ContactDefinitionsResponseFieldDefinitionValueTypeURL ContactDefinitionsResponseFieldDefinitionValueType = "URL"
const ContactDefinitionsResponseFieldDefinitionValueTypeHTML ContactDefinitionsResponseFieldDefinitionValueType = "HTML"
ID stringOptional

Unique identifier of the field definition.

AIFillable stringOptional

Whether AI fills this field automatically (ON), only suggests values (SUGGEST), or leaves it alone (OFF). Absent on built-in fields that have no id.

One of the following:
const ContactDefinitionsResponseFieldDefinitionAIFillableOn ContactDefinitionsResponseFieldDefinitionAIFillable = "ON"
const ContactDefinitionsResponseFieldDefinitionAIFillableOff ContactDefinitionsResponseFieldDefinitionAIFillable = "OFF"
const ContactDefinitionsResponseFieldDefinitionAIFillableSuggest ContactDefinitionsResponseFieldDefinitionAIFillable = "SUGGEST"
AIFillablePrompt stringOptional

Instructions AI follows when filling this field, or null when none are set. Absent on built-in fields that have no id.

Formula stringOptional

Formula a calculated field evaluates, with fields and relationships referenced by key. Null for fields that are not calculated. Absent on built-in fields that have no id.

ReadOnly boolOptional

true for fields that are not writable via the API (e.g. AI-generated summaries, calculated fields). false or absent for writable fields.

ValueSource stringOptional

Whether values are entered (MANUAL) or calculated from a formula (COMPUTED). Absent on built-in fields that have no id.

One of the following:
const ContactDefinitionsResponseFieldDefinitionValueSourceManual ContactDefinitionsResponseFieldDefinitionValueSource = "MANUAL"
const ContactDefinitionsResponseFieldDefinitionValueSourceComputed ContactDefinitionsResponseFieldDefinitionValueSource = "COMPUTED"
ObjectType string

The object type these definitions belong to (e.g. account).

RelationshipDefinitions map[string, ContactDefinitionsResponseRelationshipDefinition]

Map of relationship keys to their definitions. Self-referential relationships include optional directional metadata on the bare definition.

Archived bool

Whether the relationship definition is archived.

ArchivedAt Time

When the relationship definition was archived, or null if active.

formatdate-time
Cardinality string

Whether this is a has_one or has_many relationship.

One of the following:
const ContactDefinitionsResponseRelationshipDefinitionCardinalityHasOne ContactDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"
const ContactDefinitionsResponseRelationshipDefinitionCardinalityHasMany ContactDefinitionsResponseRelationshipDefinitionCardinality = "HAS_MANY"
Description string

Description of the relationship, or null.

Label string

Human-readable display name of the relationship, as it reads from this object type.

ObjectType string

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

ID stringOptional

Unique identifier of the relationship definition.

Directions ContactDefinitionsResponseRelationshipDefinitionDirectionsOptional

Directional metadata for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasOne ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_ONE"
const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasMany ContactDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

AsSource ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasOne ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_ONE"
const ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasMany ContactDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

GroupKey stringOptional

Key of the relationship group this relationship belongs to, as listed under relationshipGroupDefinitions. Absent when the relationship is not in a group.

Inverse ContactDefinitionsResponseRelationshipDefinitionInverseOptional

How the same relationship reads from the related object type.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactDefinitionsResponseRelationshipDefinitionInverseCardinalityHasOne ContactDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_ONE"
const ContactDefinitionsResponseRelationshipDefinitionInverseCardinalityHasMany ContactDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

RelationshipGroupDefinitions map[string, ContactDefinitionsResponseRelationshipGroupDefinition]

Map of relationship group keys to their definitions. A group collects relationships between the same two object types, such as the roles a contact can hold on an opportunity. Relationships name their group with groupKey.

ID string

Unique identifier of the relationship group.

Archived bool

Whether the relationship group is archived.

ArchivedAt Time

When the relationship group was archived, or null if active.

formatdate-time
Inverse ContactDefinitionsResponseRelationshipGroupDefinitionInverse

How the same group reads from the related object type.

Label string

Human-readable display name of the group, as it reads from the related object type.

Label string

Human-readable display name of the group, as it reads from this object type.

ObjectType string

The type of the related object every relationship in the group points to.

type ContactDeleteResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactDeleteResponseField]

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

Value ContactDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ContactDeleteResponseFieldValueArray []string
type ContactDeleteResponseFieldValueAddress 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 ContactDeleteResponseFieldValueFullName 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 ContactDeleteResponseFieldValueTypeAddress ContactDeleteResponseFieldValueType = "ADDRESS"
const ContactDeleteResponseFieldValueTypeCheckbox ContactDeleteResponseFieldValueType = "CHECKBOX"
const ContactDeleteResponseFieldValueTypeCurrency ContactDeleteResponseFieldValueType = "CURRENCY"
const ContactDeleteResponseFieldValueTypeDate ContactDeleteResponseFieldValueType = "DATE"
const ContactDeleteResponseFieldValueTypeDatetime ContactDeleteResponseFieldValueType = "DATETIME"
const ContactDeleteResponseFieldValueTypeEmail ContactDeleteResponseFieldValueType = "EMAIL"
const ContactDeleteResponseFieldValueTypeFullName ContactDeleteResponseFieldValueType = "FULL_NAME"
const ContactDeleteResponseFieldValueTypeMarkdown ContactDeleteResponseFieldValueType = "MARKDOWN"
const ContactDeleteResponseFieldValueTypeMultiSelect ContactDeleteResponseFieldValueType = "MULTI_SELECT"
const ContactDeleteResponseFieldValueTypeNumber ContactDeleteResponseFieldValueType = "NUMBER"
const ContactDeleteResponseFieldValueTypeSingleSelect ContactDeleteResponseFieldValueType = "SINGLE_SELECT"
const ContactDeleteResponseFieldValueTypeSocialHandle ContactDeleteResponseFieldValueType = "SOCIAL_HANDLE"
const ContactDeleteResponseFieldValueTypeTelephone ContactDeleteResponseFieldValueType = "TELEPHONE"
const ContactDeleteResponseFieldValueTypeText ContactDeleteResponseFieldValueType = "TEXT"
const ContactDeleteResponseFieldValueTypeURL ContactDeleteResponseFieldValueType = "URL"
const ContactDeleteResponseFieldValueTypeHTML ContactDeleteResponseFieldValueType = "HTML"
Relationships map[string, ContactDeleteResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions ContactDeleteResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ContactDeleteResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ContactDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ContactDeleteResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ContactDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.

type ContactFieldHistoryResponse struct{…}
Data []ContactFieldHistoryResponseData

Recorded values for the field, newest first.

DisplayValue string

Human-readable rendering of the value (e.g. a select option label), suitable for display.

IsCreate bool

True for the record’s original value. Only set when the full history fits in the response (never on a truncated/paginated page).

RecordedAt string

ISO 8601 timestamp of when this value was recorded.

Value ContactFieldHistoryResponseDataValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ContactFieldHistoryResponseDataValueArray []string
type ContactFieldHistoryResponseDataValueAddress 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 ContactFieldHistoryResponseDataValueFullName 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 ContactFieldHistoryResponseDataValueTypeAddress ContactFieldHistoryResponseDataValueType = "ADDRESS"
const ContactFieldHistoryResponseDataValueTypeCheckbox ContactFieldHistoryResponseDataValueType = "CHECKBOX"
const ContactFieldHistoryResponseDataValueTypeCurrency ContactFieldHistoryResponseDataValueType = "CURRENCY"
const ContactFieldHistoryResponseDataValueTypeDate ContactFieldHistoryResponseDataValueType = "DATE"
const ContactFieldHistoryResponseDataValueTypeDatetime ContactFieldHistoryResponseDataValueType = "DATETIME"
const ContactFieldHistoryResponseDataValueTypeEmail ContactFieldHistoryResponseDataValueType = "EMAIL"
const ContactFieldHistoryResponseDataValueTypeFullName ContactFieldHistoryResponseDataValueType = "FULL_NAME"
const ContactFieldHistoryResponseDataValueTypeMarkdown ContactFieldHistoryResponseDataValueType = "MARKDOWN"
const ContactFieldHistoryResponseDataValueTypeMultiSelect ContactFieldHistoryResponseDataValueType = "MULTI_SELECT"
const ContactFieldHistoryResponseDataValueTypeNumber ContactFieldHistoryResponseDataValueType = "NUMBER"
const ContactFieldHistoryResponseDataValueTypeSingleSelect ContactFieldHistoryResponseDataValueType = "SINGLE_SELECT"
const ContactFieldHistoryResponseDataValueTypeSocialHandle ContactFieldHistoryResponseDataValueType = "SOCIAL_HANDLE"
const ContactFieldHistoryResponseDataValueTypeTelephone ContactFieldHistoryResponseDataValueType = "TELEPHONE"
const ContactFieldHistoryResponseDataValueTypeText ContactFieldHistoryResponseDataValueType = "TEXT"
const ContactFieldHistoryResponseDataValueTypeURL ContactFieldHistoryResponseDataValueType = "URL"
const ContactFieldHistoryResponseDataValueTypeHTML ContactFieldHistoryResponseDataValueType = "HTML"
HasMore bool

Whether more history exists beyond this page.

NextCursor string

Cursor to pass as after to fetch the next page, or null when there are no more entries.

type ContactListResponse struct{…}
Data []ContactListResponseData

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[string, ContactListResponseDataField]

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

Value ContactListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ContactListResponseDataFieldValueArray []string
type ContactListResponseDataFieldValueAddress 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 ContactListResponseDataFieldValueFullName 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 ContactListResponseDataFieldValueTypeAddress ContactListResponseDataFieldValueType = "ADDRESS"
const ContactListResponseDataFieldValueTypeCheckbox ContactListResponseDataFieldValueType = "CHECKBOX"
const ContactListResponseDataFieldValueTypeCurrency ContactListResponseDataFieldValueType = "CURRENCY"
const ContactListResponseDataFieldValueTypeDate ContactListResponseDataFieldValueType = "DATE"
const ContactListResponseDataFieldValueTypeDatetime ContactListResponseDataFieldValueType = "DATETIME"
const ContactListResponseDataFieldValueTypeEmail ContactListResponseDataFieldValueType = "EMAIL"
const ContactListResponseDataFieldValueTypeFullName ContactListResponseDataFieldValueType = "FULL_NAME"
const ContactListResponseDataFieldValueTypeMarkdown ContactListResponseDataFieldValueType = "MARKDOWN"
const ContactListResponseDataFieldValueTypeMultiSelect ContactListResponseDataFieldValueType = "MULTI_SELECT"
const ContactListResponseDataFieldValueTypeNumber ContactListResponseDataFieldValueType = "NUMBER"
const ContactListResponseDataFieldValueTypeSingleSelect ContactListResponseDataFieldValueType = "SINGLE_SELECT"
const ContactListResponseDataFieldValueTypeSocialHandle ContactListResponseDataFieldValueType = "SOCIAL_HANDLE"
const ContactListResponseDataFieldValueTypeTelephone ContactListResponseDataFieldValueType = "TELEPHONE"
const ContactListResponseDataFieldValueTypeText ContactListResponseDataFieldValueType = "TEXT"
const ContactListResponseDataFieldValueTypeURL ContactListResponseDataFieldValueType = "URL"
const ContactListResponseDataFieldValueTypeHTML ContactListResponseDataFieldValueType = "HTML"
Relationships map[string, ContactListResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions ContactListResponseDataRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ContactListResponseDataRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne ContactListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ContactListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany ContactListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ContactListResponseDataRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne ContactListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ContactListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany ContactListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0
maximum9007199254740991
type ContactRestoreResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactRestoreResponseField]

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

Value ContactRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ContactRestoreResponseFieldValueArray []string
type ContactRestoreResponseFieldValueAddress 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 ContactRestoreResponseFieldValueFullName 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 ContactRestoreResponseFieldValueTypeAddress ContactRestoreResponseFieldValueType = "ADDRESS"
const ContactRestoreResponseFieldValueTypeCheckbox ContactRestoreResponseFieldValueType = "CHECKBOX"
const ContactRestoreResponseFieldValueTypeCurrency ContactRestoreResponseFieldValueType = "CURRENCY"
const ContactRestoreResponseFieldValueTypeDate ContactRestoreResponseFieldValueType = "DATE"
const ContactRestoreResponseFieldValueTypeDatetime ContactRestoreResponseFieldValueType = "DATETIME"
const ContactRestoreResponseFieldValueTypeEmail ContactRestoreResponseFieldValueType = "EMAIL"
const ContactRestoreResponseFieldValueTypeFullName ContactRestoreResponseFieldValueType = "FULL_NAME"
const ContactRestoreResponseFieldValueTypeMarkdown ContactRestoreResponseFieldValueType = "MARKDOWN"
const ContactRestoreResponseFieldValueTypeMultiSelect ContactRestoreResponseFieldValueType = "MULTI_SELECT"
const ContactRestoreResponseFieldValueTypeNumber ContactRestoreResponseFieldValueType = "NUMBER"
const ContactRestoreResponseFieldValueTypeSingleSelect ContactRestoreResponseFieldValueType = "SINGLE_SELECT"
const ContactRestoreResponseFieldValueTypeSocialHandle ContactRestoreResponseFieldValueType = "SOCIAL_HANDLE"
const ContactRestoreResponseFieldValueTypeTelephone ContactRestoreResponseFieldValueType = "TELEPHONE"
const ContactRestoreResponseFieldValueTypeText ContactRestoreResponseFieldValueType = "TEXT"
const ContactRestoreResponseFieldValueTypeURL ContactRestoreResponseFieldValueType = "URL"
const ContactRestoreResponseFieldValueTypeHTML ContactRestoreResponseFieldValueType = "HTML"
Relationships map[string, ContactRestoreResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions ContactRestoreResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ContactRestoreResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ContactRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ContactRestoreResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ContactRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.

type ContactRetrieveResponseUnion interface{…}
One of the following:
type ContactRetrieveResponseEntity struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactRetrieveResponseEntityField]

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

Value ContactRetrieveResponseEntityFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ContactRetrieveResponseEntityFieldValueArray []string
type ContactRetrieveResponseEntityFieldValueAddress 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 ContactRetrieveResponseEntityFieldValueFullName 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 ContactRetrieveResponseEntityFieldValueTypeAddress ContactRetrieveResponseEntityFieldValueType = "ADDRESS"
const ContactRetrieveResponseEntityFieldValueTypeCheckbox ContactRetrieveResponseEntityFieldValueType = "CHECKBOX"
const ContactRetrieveResponseEntityFieldValueTypeCurrency ContactRetrieveResponseEntityFieldValueType = "CURRENCY"
const ContactRetrieveResponseEntityFieldValueTypeDate ContactRetrieveResponseEntityFieldValueType = "DATE"
const ContactRetrieveResponseEntityFieldValueTypeDatetime ContactRetrieveResponseEntityFieldValueType = "DATETIME"
const ContactRetrieveResponseEntityFieldValueTypeEmail ContactRetrieveResponseEntityFieldValueType = "EMAIL"
const ContactRetrieveResponseEntityFieldValueTypeFullName ContactRetrieveResponseEntityFieldValueType = "FULL_NAME"
const ContactRetrieveResponseEntityFieldValueTypeMarkdown ContactRetrieveResponseEntityFieldValueType = "MARKDOWN"
const ContactRetrieveResponseEntityFieldValueTypeMultiSelect ContactRetrieveResponseEntityFieldValueType = "MULTI_SELECT"
const ContactRetrieveResponseEntityFieldValueTypeNumber ContactRetrieveResponseEntityFieldValueType = "NUMBER"
const ContactRetrieveResponseEntityFieldValueTypeSingleSelect ContactRetrieveResponseEntityFieldValueType = "SINGLE_SELECT"
const ContactRetrieveResponseEntityFieldValueTypeSocialHandle ContactRetrieveResponseEntityFieldValueType = "SOCIAL_HANDLE"
const ContactRetrieveResponseEntityFieldValueTypeTelephone ContactRetrieveResponseEntityFieldValueType = "TELEPHONE"
const ContactRetrieveResponseEntityFieldValueTypeText ContactRetrieveResponseEntityFieldValueType = "TEXT"
const ContactRetrieveResponseEntityFieldValueTypeURL ContactRetrieveResponseEntityFieldValueType = "URL"
const ContactRetrieveResponseEntityFieldValueTypeHTML ContactRetrieveResponseEntityFieldValueType = "HTML"
Relationships map[string, ContactRetrieveResponseEntityRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions ContactRetrieveResponseEntityRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ContactRetrieveResponseEntityRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasOne ContactRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ContactRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasMany ContactRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ContactRetrieveResponseEntityRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasOne ContactRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ContactRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasMany ContactRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.

type ContactRetrieveResponseRestricted struct{…}
ID string

Unique identifier for the record, the same ID a full response carries.

Restricted ContactRetrieveResponseRestrictedRestricted

Present only on a record the caller may know exists but not read. Check for it before reading fields or relationships, which a restricted record does not carry.

Name string

A label for the record’s type, such as “Restricted opportunity”. Never the record’s name.

Reason string

Why the record is restricted.

One of the following:
const ContactRetrieveResponseRestrictedRestrictedReasonNoAccess ContactRetrieveResponseRestrictedRestrictedReason = "NO_ACCESS"
const ContactRetrieveResponseRestrictedRestrictedReasonInherited ContactRetrieveResponseRestrictedRestrictedReason = "INHERITED"
type ContactUpdateResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactUpdateResponseField]

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

Value ContactUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ContactUpdateResponseFieldValueArray []string
type ContactUpdateResponseFieldValueAddress 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 ContactUpdateResponseFieldValueFullName 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 ContactUpdateResponseFieldValueTypeAddress ContactUpdateResponseFieldValueType = "ADDRESS"
const ContactUpdateResponseFieldValueTypeCheckbox ContactUpdateResponseFieldValueType = "CHECKBOX"
const ContactUpdateResponseFieldValueTypeCurrency ContactUpdateResponseFieldValueType = "CURRENCY"
const ContactUpdateResponseFieldValueTypeDate ContactUpdateResponseFieldValueType = "DATE"
const ContactUpdateResponseFieldValueTypeDatetime ContactUpdateResponseFieldValueType = "DATETIME"
const ContactUpdateResponseFieldValueTypeEmail ContactUpdateResponseFieldValueType = "EMAIL"
const ContactUpdateResponseFieldValueTypeFullName ContactUpdateResponseFieldValueType = "FULL_NAME"
const ContactUpdateResponseFieldValueTypeMarkdown ContactUpdateResponseFieldValueType = "MARKDOWN"
const ContactUpdateResponseFieldValueTypeMultiSelect ContactUpdateResponseFieldValueType = "MULTI_SELECT"
const ContactUpdateResponseFieldValueTypeNumber ContactUpdateResponseFieldValueType = "NUMBER"
const ContactUpdateResponseFieldValueTypeSingleSelect ContactUpdateResponseFieldValueType = "SINGLE_SELECT"
const ContactUpdateResponseFieldValueTypeSocialHandle ContactUpdateResponseFieldValueType = "SOCIAL_HANDLE"
const ContactUpdateResponseFieldValueTypeTelephone ContactUpdateResponseFieldValueType = "TELEPHONE"
const ContactUpdateResponseFieldValueTypeText ContactUpdateResponseFieldValueType = "TEXT"
const ContactUpdateResponseFieldValueTypeURL ContactUpdateResponseFieldValueType = "URL"
const ContactUpdateResponseFieldValueTypeHTML ContactUpdateResponseFieldValueType = "HTML"
Relationships map[string, ContactUpdateResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions ContactUpdateResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ContactUpdateResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ContactUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ContactUpdateResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ContactUpdateResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ContactUpdateResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.