Opportunity Model

Represents an opportunity that is stored in Capsule.

Name Type Description
id Long Read only

The unique id of this opportunity.

createdAt Date Read only

The ISO date/time this opportunity was created.

updatedAt Date Read only

The ISO date/time when this opportunity was last updated.

party Nested Party Required

The main contact for this opportunity.

name String Required

The name of this opportunity.

description String

The description of this opportunity.

owner Nested User

The user this opportunity is assigned to. This and/or team is required.

team Nested Team

The team this opportunity is assigned to. This and/or owner is required.

milestone Nested Milestone Required

The milestone for this opportunity.

value Opportunity Value

The value of this opportunity.

expectedCloseOn Date

The expected close date of this opportunity.

probability Long

The probability of winning this opportunity.

durationBasis String

The time unit used by the duration field.

Accepted values are: FIXED, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR

duration Integer

The duration of this opportunity. Must be null if durationBasis is set to FIXED.

closedOn Date

The date this opportunity was closed.

tags Array of Tag

An array of tags that are added to this opportunity. This field is include in responses only if the embed parameter contains tags.

fields Array of Field Value

An array of custom fields that are defined for this opportunity. This field is include in responses only if the embed parameter contains fields.