Message

Messages represent messages synced from connected chat providers in Lightfield. Read responses are visibility-aware and may be redacted based on the caller.

Retrieve a message

client.Message.Get(ctx, id) (*MessageRetrieveResponse, error)

GET/v1/messages/{id}

List messages

client.Message.List(ctx, query) (*MessageListResponse, error)

GET/v1/messages

ModelsExpand Collapse

type MessageListResponse struct{…}

Data []MessageListResponseData

Array of message objects for the current page.

ID string

Unique identifier for the entity.

AccessLevel string

The caller’s resolved access level for this message.

One of the following:

const MessageListResponseDataAccessLevelFull MessageListResponseDataAccessLevel = "FULL"

const MessageListResponseDataAccessLevelMetadata MessageListResponseDataAccessLevel = "METADATA"

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MessageListResponseDataField]

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

Value MessageListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type MessageListResponseDataFieldValueArray []string

type MessageListResponseDataFieldValueAddress 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 MessageListResponseDataFieldValueFullName 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 MessageListResponseDataFieldValueTypeAddress MessageListResponseDataFieldValueType = "ADDRESS"

const MessageListResponseDataFieldValueTypeCheckbox MessageListResponseDataFieldValueType = "CHECKBOX"

const MessageListResponseDataFieldValueTypeCurrency MessageListResponseDataFieldValueType = "CURRENCY"

const MessageListResponseDataFieldValueTypeDatetime MessageListResponseDataFieldValueType = "DATETIME"

const MessageListResponseDataFieldValueTypeEmail MessageListResponseDataFieldValueType = "EMAIL"

const MessageListResponseDataFieldValueTypeFullName MessageListResponseDataFieldValueType = "FULL_NAME"

const MessageListResponseDataFieldValueTypeMarkdown MessageListResponseDataFieldValueType = "MARKDOWN"

const MessageListResponseDataFieldValueTypeMultiSelect MessageListResponseDataFieldValueType = "MULTI_SELECT"

const MessageListResponseDataFieldValueTypeNumber MessageListResponseDataFieldValueType = "NUMBER"

const MessageListResponseDataFieldValueTypeSingleSelect MessageListResponseDataFieldValueType = "SINGLE_SELECT"

const MessageListResponseDataFieldValueTypeSocialHandle MessageListResponseDataFieldValueType = "SOCIAL_HANDLE"

const MessageListResponseDataFieldValueTypeTelephone MessageListResponseDataFieldValueType = "TELEPHONE"

const MessageListResponseDataFieldValueTypeText MessageListResponseDataFieldValueType = "TEXT"

const MessageListResponseDataFieldValueTypeURL MessageListResponseDataFieldValueType = "URL"

const MessageListResponseDataFieldValueTypeHTML MessageListResponseDataFieldValueType = "HTML"

HTTPLink string

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

ObjectType string

Always message.

Relationships map[string, MessageListResponseDataRelationship]

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.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0

maximum9007199254740991

type MessageRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

AccessLevel MessageRetrieveResponseAccessLevel

The caller’s resolved access level for this message.

One of the following:

const MessageRetrieveResponseAccessLevelFull MessageRetrieveResponseAccessLevel = "FULL"

const MessageRetrieveResponseAccessLevelMetadata MessageRetrieveResponseAccessLevel = "METADATA"

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MessageRetrieveResponseField]

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

Value MessageRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type MessageRetrieveResponseFieldValueArray []string

type MessageRetrieveResponseFieldValueAddress 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 MessageRetrieveResponseFieldValueFullName 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 MessageRetrieveResponseFieldValueTypeAddress MessageRetrieveResponseFieldValueType = "ADDRESS"

const MessageRetrieveResponseFieldValueTypeCheckbox MessageRetrieveResponseFieldValueType = "CHECKBOX"

const MessageRetrieveResponseFieldValueTypeCurrency MessageRetrieveResponseFieldValueType = "CURRENCY"

const MessageRetrieveResponseFieldValueTypeDatetime MessageRetrieveResponseFieldValueType = "DATETIME"

const MessageRetrieveResponseFieldValueTypeEmail MessageRetrieveResponseFieldValueType = "EMAIL"

const MessageRetrieveResponseFieldValueTypeFullName MessageRetrieveResponseFieldValueType = "FULL_NAME"

const MessageRetrieveResponseFieldValueTypeMarkdown MessageRetrieveResponseFieldValueType = "MARKDOWN"

const MessageRetrieveResponseFieldValueTypeMultiSelect MessageRetrieveResponseFieldValueType = "MULTI_SELECT"

const MessageRetrieveResponseFieldValueTypeNumber MessageRetrieveResponseFieldValueType = "NUMBER"

const MessageRetrieveResponseFieldValueTypeSingleSelect MessageRetrieveResponseFieldValueType = "SINGLE_SELECT"

const MessageRetrieveResponseFieldValueTypeSocialHandle MessageRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const MessageRetrieveResponseFieldValueTypeTelephone MessageRetrieveResponseFieldValueType = "TELEPHONE"

const MessageRetrieveResponseFieldValueTypeText MessageRetrieveResponseFieldValueType = "TEXT"

const MessageRetrieveResponseFieldValueTypeURL MessageRetrieveResponseFieldValueType = "URL"

const MessageRetrieveResponseFieldValueTypeHTML MessageRetrieveResponseFieldValueType = "HTML"

HTTPLink string

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

ObjectType MessageRetrieveResponseObjectType

Always message.

Relationships map[string, MessageRetrieveResponseRelationship]

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.