Skip to content

Opportunity

Opportunities represent potential deals or sales in Lightfield. Each opportunity belongs to an account and can have tasks and notes associated with it.

Get opportunity field definitions
client.Opportunity.Definitions(ctx, query) (*OpportunityDefinitionsResponse, error)
GET/v1/opportunities/definitions
Get field value history
client.Opportunity.FieldHistory(ctx, fieldKey, params) (*OpportunityFieldHistoryResponse, error)
GET/v1/opportunities/{id}/fields/{fieldKey}/history
Create an opportunity
client.Opportunity.New(ctx, body) (*OpportunityCreateResponse, error)
POST/v1/opportunities
Update an opportunity
client.Opportunity.Update(ctx, id, body) (*OpportunityUpdateResponse, error)
POST/v1/opportunities/{id}
Retrieve an opportunity
client.Opportunity.Get(ctx, id) (*OpportunityRetrieveResponseUnion, error)
GET/v1/opportunities/{id}
List opportunities
client.Opportunity.List(ctx, query) (*OpportunityListResponse, error)
GET/v1/opportunities
Delete an opportunity
client.Opportunity.Delete(ctx, id, body) (*OpportunityDeleteResponse, error)
DELETE/v1/opportunities/{id}
Restore an opportunity
client.Opportunity.Restore(ctx, id, body) (*OpportunityRestoreResponse, error)
POST/v1/opportunities/{id}/restore
ModelsExpand Collapse
type OpportunityCreateResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityCreateResponseField]

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

Value OpportunityCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityCreateResponseFieldValueArray []string
type OpportunityCreateResponseFieldValueAddress 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 OpportunityCreateResponseFieldValueFullName 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 OpportunityCreateResponseFieldValueTypeAddress OpportunityCreateResponseFieldValueType = "ADDRESS"
const OpportunityCreateResponseFieldValueTypeCheckbox OpportunityCreateResponseFieldValueType = "CHECKBOX"
const OpportunityCreateResponseFieldValueTypeCurrency OpportunityCreateResponseFieldValueType = "CURRENCY"
const OpportunityCreateResponseFieldValueTypeDate OpportunityCreateResponseFieldValueType = "DATE"
const OpportunityCreateResponseFieldValueTypeDatetime OpportunityCreateResponseFieldValueType = "DATETIME"
const OpportunityCreateResponseFieldValueTypeEmail OpportunityCreateResponseFieldValueType = "EMAIL"
const OpportunityCreateResponseFieldValueTypeFullName OpportunityCreateResponseFieldValueType = "FULL_NAME"
const OpportunityCreateResponseFieldValueTypeMarkdown OpportunityCreateResponseFieldValueType = "MARKDOWN"
const OpportunityCreateResponseFieldValueTypeMultiSelect OpportunityCreateResponseFieldValueType = "MULTI_SELECT"
const OpportunityCreateResponseFieldValueTypeNumber OpportunityCreateResponseFieldValueType = "NUMBER"
const OpportunityCreateResponseFieldValueTypeSingleSelect OpportunityCreateResponseFieldValueType = "SINGLE_SELECT"
const OpportunityCreateResponseFieldValueTypeSocialHandle OpportunityCreateResponseFieldValueType = "SOCIAL_HANDLE"
const OpportunityCreateResponseFieldValueTypeTelephone OpportunityCreateResponseFieldValueType = "TELEPHONE"
const OpportunityCreateResponseFieldValueTypeText OpportunityCreateResponseFieldValueType = "TEXT"
const OpportunityCreateResponseFieldValueTypeURL OpportunityCreateResponseFieldValueType = "URL"
const OpportunityCreateResponseFieldValueTypeHTML OpportunityCreateResponseFieldValueType = "HTML"
Relationships map[string, OpportunityCreateResponseRelationship]

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 OpportunityCreateResponseRelationshipDirectionsOptional

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 OpportunityCreateResponseRelationshipDirectionsAsDestination

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 OpportunityCreateResponseRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityCreateResponseRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityCreateResponseRelationshipDirectionsAsSource

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 OpportunityCreateResponseRelationshipDirectionsAsSourceCardinalityHasOne OpportunityCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityCreateResponseRelationshipDirectionsAsSourceCardinalityHasMany OpportunityCreateResponseRelationshipDirectionsAsSourceCardinality = "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 OpportunityDefinitionsResponse struct{…}
FieldDefinitions map[string, OpportunityDefinitionsResponseFieldDefinition]

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 OpportunityDefinitionsResponseFieldDefinitionTypeConfiguration

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 OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"
MultipleValues boolOptional

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

Options []OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

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 OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryActive OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "ACTIVE"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryCompleted OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "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 OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorRed OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "RED"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorOrange OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "ORANGE"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorYellow OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "YELLOW"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorLime OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "LIME"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGreen OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GREEN"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorBlue OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "BLUE"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorIndigo OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "INDIGO"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorPurple OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "PURPLE"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorCopper OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "COPPER"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGray OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "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 OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconBacklog OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "BACKLOG"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconQualification OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "QUALIFICATION"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconDiscovery OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "DISCOVERY"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconActive OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "ACTIVE"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconNegotiation OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "NEGOTIATION"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedWon OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_WON"
const OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedLost OpportunityDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "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 OpportunityDefinitionsResponseFieldDefinitionValueTypeAddress OpportunityDefinitionsResponseFieldDefinitionValueType = "ADDRESS"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeCheckbox OpportunityDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeCurrency OpportunityDefinitionsResponseFieldDefinitionValueType = "CURRENCY"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeDate OpportunityDefinitionsResponseFieldDefinitionValueType = "DATE"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeDatetime OpportunityDefinitionsResponseFieldDefinitionValueType = "DATETIME"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeEmail OpportunityDefinitionsResponseFieldDefinitionValueType = "EMAIL"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeFullName OpportunityDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeMarkdown OpportunityDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeMultiSelect OpportunityDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeNumber OpportunityDefinitionsResponseFieldDefinitionValueType = "NUMBER"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeSingleSelect OpportunityDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeSocialHandle OpportunityDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeTelephone OpportunityDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeText OpportunityDefinitionsResponseFieldDefinitionValueType = "TEXT"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeURL OpportunityDefinitionsResponseFieldDefinitionValueType = "URL"
const OpportunityDefinitionsResponseFieldDefinitionValueTypeHTML OpportunityDefinitionsResponseFieldDefinitionValueType = "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 OpportunityDefinitionsResponseFieldDefinitionAIFillableOn OpportunityDefinitionsResponseFieldDefinitionAIFillable = "ON"
const OpportunityDefinitionsResponseFieldDefinitionAIFillableOff OpportunityDefinitionsResponseFieldDefinitionAIFillable = "OFF"
const OpportunityDefinitionsResponseFieldDefinitionAIFillableSuggest OpportunityDefinitionsResponseFieldDefinitionAIFillable = "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 OpportunityDefinitionsResponseFieldDefinitionValueSourceManual OpportunityDefinitionsResponseFieldDefinitionValueSource = "MANUAL"
const OpportunityDefinitionsResponseFieldDefinitionValueSourceComputed OpportunityDefinitionsResponseFieldDefinitionValueSource = "COMPUTED"
ObjectType string

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

RelationshipDefinitions map[string, OpportunityDefinitionsResponseRelationshipDefinition]

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 OpportunityDefinitionsResponseRelationshipDefinitionCardinalityHasOne OpportunityDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"
const OpportunityDefinitionsResponseRelationshipDefinitionCardinalityHasMany OpportunityDefinitionsResponseRelationshipDefinitionCardinality = "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 OpportunityDefinitionsResponseRelationshipDefinitionDirectionsOptional

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 OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsDestination

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 OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasOne OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasMany OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

AsSource OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsSource

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 OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasOne OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasMany OpportunityDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "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 OpportunityDefinitionsResponseRelationshipDefinitionInverseOptional

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 OpportunityDefinitionsResponseRelationshipDefinitionInverseCardinalityHasOne OpportunityDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_ONE"
const OpportunityDefinitionsResponseRelationshipDefinitionInverseCardinalityHasMany OpportunityDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

RelationshipGroupDefinitions map[string, OpportunityDefinitionsResponseRelationshipGroupDefinition]

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 OpportunityDefinitionsResponseRelationshipGroupDefinitionInverse

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 OpportunityDeleteResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityDeleteResponseField]

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

Value OpportunityDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityDeleteResponseFieldValueArray []string
type OpportunityDeleteResponseFieldValueAddress 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 OpportunityDeleteResponseFieldValueFullName 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 OpportunityDeleteResponseFieldValueTypeAddress OpportunityDeleteResponseFieldValueType = "ADDRESS"
const OpportunityDeleteResponseFieldValueTypeCheckbox OpportunityDeleteResponseFieldValueType = "CHECKBOX"
const OpportunityDeleteResponseFieldValueTypeCurrency OpportunityDeleteResponseFieldValueType = "CURRENCY"
const OpportunityDeleteResponseFieldValueTypeDate OpportunityDeleteResponseFieldValueType = "DATE"
const OpportunityDeleteResponseFieldValueTypeDatetime OpportunityDeleteResponseFieldValueType = "DATETIME"
const OpportunityDeleteResponseFieldValueTypeEmail OpportunityDeleteResponseFieldValueType = "EMAIL"
const OpportunityDeleteResponseFieldValueTypeFullName OpportunityDeleteResponseFieldValueType = "FULL_NAME"
const OpportunityDeleteResponseFieldValueTypeMarkdown OpportunityDeleteResponseFieldValueType = "MARKDOWN"
const OpportunityDeleteResponseFieldValueTypeMultiSelect OpportunityDeleteResponseFieldValueType = "MULTI_SELECT"
const OpportunityDeleteResponseFieldValueTypeNumber OpportunityDeleteResponseFieldValueType = "NUMBER"
const OpportunityDeleteResponseFieldValueTypeSingleSelect OpportunityDeleteResponseFieldValueType = "SINGLE_SELECT"
const OpportunityDeleteResponseFieldValueTypeSocialHandle OpportunityDeleteResponseFieldValueType = "SOCIAL_HANDLE"
const OpportunityDeleteResponseFieldValueTypeTelephone OpportunityDeleteResponseFieldValueType = "TELEPHONE"
const OpportunityDeleteResponseFieldValueTypeText OpportunityDeleteResponseFieldValueType = "TEXT"
const OpportunityDeleteResponseFieldValueTypeURL OpportunityDeleteResponseFieldValueType = "URL"
const OpportunityDeleteResponseFieldValueTypeHTML OpportunityDeleteResponseFieldValueType = "HTML"
Relationships map[string, OpportunityDeleteResponseRelationship]

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 OpportunityDeleteResponseRelationshipDirectionsOptional

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 OpportunityDeleteResponseRelationshipDirectionsAsDestination

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 OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityDeleteResponseRelationshipDirectionsAsSource

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 OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinality = "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 OpportunityFieldHistoryResponse struct{…}
Data []OpportunityFieldHistoryResponseData

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 OpportunityFieldHistoryResponseDataValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityFieldHistoryResponseDataValueArray []string
type OpportunityFieldHistoryResponseDataValueAddress 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 OpportunityFieldHistoryResponseDataValueFullName 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 OpportunityFieldHistoryResponseDataValueTypeAddress OpportunityFieldHistoryResponseDataValueType = "ADDRESS"
const OpportunityFieldHistoryResponseDataValueTypeCheckbox OpportunityFieldHistoryResponseDataValueType = "CHECKBOX"
const OpportunityFieldHistoryResponseDataValueTypeCurrency OpportunityFieldHistoryResponseDataValueType = "CURRENCY"
const OpportunityFieldHistoryResponseDataValueTypeDate OpportunityFieldHistoryResponseDataValueType = "DATE"
const OpportunityFieldHistoryResponseDataValueTypeDatetime OpportunityFieldHistoryResponseDataValueType = "DATETIME"
const OpportunityFieldHistoryResponseDataValueTypeEmail OpportunityFieldHistoryResponseDataValueType = "EMAIL"
const OpportunityFieldHistoryResponseDataValueTypeFullName OpportunityFieldHistoryResponseDataValueType = "FULL_NAME"
const OpportunityFieldHistoryResponseDataValueTypeMarkdown OpportunityFieldHistoryResponseDataValueType = "MARKDOWN"
const OpportunityFieldHistoryResponseDataValueTypeMultiSelect OpportunityFieldHistoryResponseDataValueType = "MULTI_SELECT"
const OpportunityFieldHistoryResponseDataValueTypeNumber OpportunityFieldHistoryResponseDataValueType = "NUMBER"
const OpportunityFieldHistoryResponseDataValueTypeSingleSelect OpportunityFieldHistoryResponseDataValueType = "SINGLE_SELECT"
const OpportunityFieldHistoryResponseDataValueTypeSocialHandle OpportunityFieldHistoryResponseDataValueType = "SOCIAL_HANDLE"
const OpportunityFieldHistoryResponseDataValueTypeTelephone OpportunityFieldHistoryResponseDataValueType = "TELEPHONE"
const OpportunityFieldHistoryResponseDataValueTypeText OpportunityFieldHistoryResponseDataValueType = "TEXT"
const OpportunityFieldHistoryResponseDataValueTypeURL OpportunityFieldHistoryResponseDataValueType = "URL"
const OpportunityFieldHistoryResponseDataValueTypeHTML OpportunityFieldHistoryResponseDataValueType = "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 OpportunityListResponse struct{…}
Data []OpportunityListResponseData

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, OpportunityListResponseDataField]

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

Value OpportunityListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityListResponseDataFieldValueArray []string
type OpportunityListResponseDataFieldValueAddress 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 OpportunityListResponseDataFieldValueFullName 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 OpportunityListResponseDataFieldValueTypeAddress OpportunityListResponseDataFieldValueType = "ADDRESS"
const OpportunityListResponseDataFieldValueTypeCheckbox OpportunityListResponseDataFieldValueType = "CHECKBOX"
const OpportunityListResponseDataFieldValueTypeCurrency OpportunityListResponseDataFieldValueType = "CURRENCY"
const OpportunityListResponseDataFieldValueTypeDate OpportunityListResponseDataFieldValueType = "DATE"
const OpportunityListResponseDataFieldValueTypeDatetime OpportunityListResponseDataFieldValueType = "DATETIME"
const OpportunityListResponseDataFieldValueTypeEmail OpportunityListResponseDataFieldValueType = "EMAIL"
const OpportunityListResponseDataFieldValueTypeFullName OpportunityListResponseDataFieldValueType = "FULL_NAME"
const OpportunityListResponseDataFieldValueTypeMarkdown OpportunityListResponseDataFieldValueType = "MARKDOWN"
const OpportunityListResponseDataFieldValueTypeMultiSelect OpportunityListResponseDataFieldValueType = "MULTI_SELECT"
const OpportunityListResponseDataFieldValueTypeNumber OpportunityListResponseDataFieldValueType = "NUMBER"
const OpportunityListResponseDataFieldValueTypeSingleSelect OpportunityListResponseDataFieldValueType = "SINGLE_SELECT"
const OpportunityListResponseDataFieldValueTypeSocialHandle OpportunityListResponseDataFieldValueType = "SOCIAL_HANDLE"
const OpportunityListResponseDataFieldValueTypeTelephone OpportunityListResponseDataFieldValueType = "TELEPHONE"
const OpportunityListResponseDataFieldValueTypeText OpportunityListResponseDataFieldValueType = "TEXT"
const OpportunityListResponseDataFieldValueTypeURL OpportunityListResponseDataFieldValueType = "URL"
const OpportunityListResponseDataFieldValueTypeHTML OpportunityListResponseDataFieldValueType = "HTML"
Relationships map[string, OpportunityListResponseDataRelationship]

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 OpportunityListResponseDataRelationshipDirectionsOptional

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 OpportunityListResponseDataRelationshipDirectionsAsDestination

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 OpportunityListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityListResponseDataRelationshipDirectionsAsSource

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 OpportunityListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne OpportunityListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany OpportunityListResponseDataRelationshipDirectionsAsSourceCardinality = "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 OpportunityRestoreResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityRestoreResponseField]

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

Value OpportunityRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityRestoreResponseFieldValueArray []string
type OpportunityRestoreResponseFieldValueAddress 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 OpportunityRestoreResponseFieldValueFullName 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 OpportunityRestoreResponseFieldValueTypeAddress OpportunityRestoreResponseFieldValueType = "ADDRESS"
const OpportunityRestoreResponseFieldValueTypeCheckbox OpportunityRestoreResponseFieldValueType = "CHECKBOX"
const OpportunityRestoreResponseFieldValueTypeCurrency OpportunityRestoreResponseFieldValueType = "CURRENCY"
const OpportunityRestoreResponseFieldValueTypeDate OpportunityRestoreResponseFieldValueType = "DATE"
const OpportunityRestoreResponseFieldValueTypeDatetime OpportunityRestoreResponseFieldValueType = "DATETIME"
const OpportunityRestoreResponseFieldValueTypeEmail OpportunityRestoreResponseFieldValueType = "EMAIL"
const OpportunityRestoreResponseFieldValueTypeFullName OpportunityRestoreResponseFieldValueType = "FULL_NAME"
const OpportunityRestoreResponseFieldValueTypeMarkdown OpportunityRestoreResponseFieldValueType = "MARKDOWN"
const OpportunityRestoreResponseFieldValueTypeMultiSelect OpportunityRestoreResponseFieldValueType = "MULTI_SELECT"
const OpportunityRestoreResponseFieldValueTypeNumber OpportunityRestoreResponseFieldValueType = "NUMBER"
const OpportunityRestoreResponseFieldValueTypeSingleSelect OpportunityRestoreResponseFieldValueType = "SINGLE_SELECT"
const OpportunityRestoreResponseFieldValueTypeSocialHandle OpportunityRestoreResponseFieldValueType = "SOCIAL_HANDLE"
const OpportunityRestoreResponseFieldValueTypeTelephone OpportunityRestoreResponseFieldValueType = "TELEPHONE"
const OpportunityRestoreResponseFieldValueTypeText OpportunityRestoreResponseFieldValueType = "TEXT"
const OpportunityRestoreResponseFieldValueTypeURL OpportunityRestoreResponseFieldValueType = "URL"
const OpportunityRestoreResponseFieldValueTypeHTML OpportunityRestoreResponseFieldValueType = "HTML"
Relationships map[string, OpportunityRestoreResponseRelationship]

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 OpportunityRestoreResponseRelationshipDirectionsOptional

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 OpportunityRestoreResponseRelationshipDirectionsAsDestination

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 OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityRestoreResponseRelationshipDirectionsAsSource

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 OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinality = "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 OpportunityRetrieveResponseUnion interface{…}
One of the following:
type OpportunityRetrieveResponseEntity struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityRetrieveResponseEntityField]

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

Value OpportunityRetrieveResponseEntityFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityRetrieveResponseEntityFieldValueArray []string
type OpportunityRetrieveResponseEntityFieldValueAddress 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 OpportunityRetrieveResponseEntityFieldValueFullName 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 OpportunityRetrieveResponseEntityFieldValueTypeAddress OpportunityRetrieveResponseEntityFieldValueType = "ADDRESS"
const OpportunityRetrieveResponseEntityFieldValueTypeCheckbox OpportunityRetrieveResponseEntityFieldValueType = "CHECKBOX"
const OpportunityRetrieveResponseEntityFieldValueTypeCurrency OpportunityRetrieveResponseEntityFieldValueType = "CURRENCY"
const OpportunityRetrieveResponseEntityFieldValueTypeDate OpportunityRetrieveResponseEntityFieldValueType = "DATE"
const OpportunityRetrieveResponseEntityFieldValueTypeDatetime OpportunityRetrieveResponseEntityFieldValueType = "DATETIME"
const OpportunityRetrieveResponseEntityFieldValueTypeEmail OpportunityRetrieveResponseEntityFieldValueType = "EMAIL"
const OpportunityRetrieveResponseEntityFieldValueTypeFullName OpportunityRetrieveResponseEntityFieldValueType = "FULL_NAME"
const OpportunityRetrieveResponseEntityFieldValueTypeMarkdown OpportunityRetrieveResponseEntityFieldValueType = "MARKDOWN"
const OpportunityRetrieveResponseEntityFieldValueTypeMultiSelect OpportunityRetrieveResponseEntityFieldValueType = "MULTI_SELECT"
const OpportunityRetrieveResponseEntityFieldValueTypeNumber OpportunityRetrieveResponseEntityFieldValueType = "NUMBER"
const OpportunityRetrieveResponseEntityFieldValueTypeSingleSelect OpportunityRetrieveResponseEntityFieldValueType = "SINGLE_SELECT"
const OpportunityRetrieveResponseEntityFieldValueTypeSocialHandle OpportunityRetrieveResponseEntityFieldValueType = "SOCIAL_HANDLE"
const OpportunityRetrieveResponseEntityFieldValueTypeTelephone OpportunityRetrieveResponseEntityFieldValueType = "TELEPHONE"
const OpportunityRetrieveResponseEntityFieldValueTypeText OpportunityRetrieveResponseEntityFieldValueType = "TEXT"
const OpportunityRetrieveResponseEntityFieldValueTypeURL OpportunityRetrieveResponseEntityFieldValueType = "URL"
const OpportunityRetrieveResponseEntityFieldValueTypeHTML OpportunityRetrieveResponseEntityFieldValueType = "HTML"
Relationships map[string, OpportunityRetrieveResponseEntityRelationship]

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 OpportunityRetrieveResponseEntityRelationshipDirectionsOptional

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 OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestination

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 OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityRetrieveResponseEntityRelationshipDirectionsAsSource

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 OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasOne OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasMany OpportunityRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "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 OpportunityRetrieveResponseRestricted struct{…}
ID string

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

Restricted OpportunityRetrieveResponseRestrictedRestricted

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 OpportunityRetrieveResponseRestrictedRestrictedReasonNoAccess OpportunityRetrieveResponseRestrictedRestrictedReason = "NO_ACCESS"
const OpportunityRetrieveResponseRestrictedRestrictedReasonInherited OpportunityRetrieveResponseRestrictedRestrictedReason = "INHERITED"
type OpportunityUpdateResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityUpdateResponseField]

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

Value OpportunityUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityUpdateResponseFieldValueArray []string
type OpportunityUpdateResponseFieldValueAddress 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 OpportunityUpdateResponseFieldValueFullName 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 OpportunityUpdateResponseFieldValueTypeAddress OpportunityUpdateResponseFieldValueType = "ADDRESS"
const OpportunityUpdateResponseFieldValueTypeCheckbox OpportunityUpdateResponseFieldValueType = "CHECKBOX"
const OpportunityUpdateResponseFieldValueTypeCurrency OpportunityUpdateResponseFieldValueType = "CURRENCY"
const OpportunityUpdateResponseFieldValueTypeDate OpportunityUpdateResponseFieldValueType = "DATE"
const OpportunityUpdateResponseFieldValueTypeDatetime OpportunityUpdateResponseFieldValueType = "DATETIME"
const OpportunityUpdateResponseFieldValueTypeEmail OpportunityUpdateResponseFieldValueType = "EMAIL"
const OpportunityUpdateResponseFieldValueTypeFullName OpportunityUpdateResponseFieldValueType = "FULL_NAME"
const OpportunityUpdateResponseFieldValueTypeMarkdown OpportunityUpdateResponseFieldValueType = "MARKDOWN"
const OpportunityUpdateResponseFieldValueTypeMultiSelect OpportunityUpdateResponseFieldValueType = "MULTI_SELECT"
const OpportunityUpdateResponseFieldValueTypeNumber OpportunityUpdateResponseFieldValueType = "NUMBER"
const OpportunityUpdateResponseFieldValueTypeSingleSelect OpportunityUpdateResponseFieldValueType = "SINGLE_SELECT"
const OpportunityUpdateResponseFieldValueTypeSocialHandle OpportunityUpdateResponseFieldValueType = "SOCIAL_HANDLE"
const OpportunityUpdateResponseFieldValueTypeTelephone OpportunityUpdateResponseFieldValueType = "TELEPHONE"
const OpportunityUpdateResponseFieldValueTypeText OpportunityUpdateResponseFieldValueType = "TEXT"
const OpportunityUpdateResponseFieldValueTypeURL OpportunityUpdateResponseFieldValueType = "URL"
const OpportunityUpdateResponseFieldValueTypeHTML OpportunityUpdateResponseFieldValueType = "HTML"
Relationships map[string, OpportunityUpdateResponseRelationship]

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 OpportunityUpdateResponseRelationshipDirectionsOptional

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 OpportunityUpdateResponseRelationshipDirectionsAsDestination

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 OpportunityUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityUpdateResponseRelationshipDirectionsAsSource

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 OpportunityUpdateResponseRelationshipDirectionsAsSourceCardinalityHasOne OpportunityUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityUpdateResponseRelationshipDirectionsAsSourceCardinalityHasMany OpportunityUpdateResponseRelationshipDirectionsAsSourceCardinality = "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.