| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
Optional<String> | ➖ | A unique identifier for the opportunity. | 12345 |
title |
String | ✔️ | The title or name of the opportunity. | New Rocket |
primaryContactId |
JsonNullable<String> | ➖ | The unique identifier of the primary contact associated with the opportunity. | 12345 |
description |
JsonNullable<String> | ➖ | A description of the opportunity. | Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. |
type |
JsonNullable<String> | ➖ | The type of the opportunity | Existing Customer - Upgrade |
monetaryAmount |
JsonNullable<Double> | ➖ | The monetary value associated with the opportunity | 75000 |
currency |
JsonNullable<Currency> | ➖ | Indicates the associated currency for an amount of money. Values correspond to ISO 4217. | USD |
winProbability |
JsonNullable<Double> | ➖ | The probability of winning the opportunity, expressed as a percentage. | 40 |
expectedRevenue |
JsonNullable<Double> | ➖ | The expected revenue from the opportunity | 75000 |
closeDate |
LocalDate | ➖ | The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet. | 2020-10-30 |
lossReasonId |
JsonNullable<String> | ➖ | The unique identifier of the reason why the opportunity was lost. | 12345 |
lossReason |
JsonNullable<String> | ➖ | The reason why the opportunity was lost. | No budget |
wonReasonId |
JsonNullable<String> | ➖ | The unique identifier of the reason why the opportunity was won. | 12345 |
wonReason |
JsonNullable<String> | ➖ | The reason why the opportunity was won. | Best pitch |
pipelineId |
JsonNullable<String> | ➖ | The unique identifier of the pipeline associated with the opportunity | 12345 |
pipelineStageId |
JsonNullable<String> | ➖ | The unique identifier of the stage in the pipeline associated with the opportunity. | 12345 |
sourceId |
JsonNullable<String> | ➖ | The unique identifier of the source of the opportunity. | 12345 |
leadId |
JsonNullable<String> | ➖ | The unique identifier of the lead associated with the opportunity. | 12345 |
leadSource |
JsonNullable<String> | ➖ | The source of the lead associated with the opportunity. | Website |
contactId |
JsonNullable<String> | ➖ | The unique identifier of the contact associated with the opportunity. | 12345 |
contactIds |
List<String> | ➖ | An array of unique identifiers of all contacts associated with the opportunity. | |
companyId |
JsonNullable<String> | ➖ | The unique identifier of the company associated with the opportunity. | 12345 |
companyName |
JsonNullable<String> | ➖ | The name of the company associated with the opportunity. | Copper |
ownerId |
JsonNullable<String> | ➖ | The unique identifier of the user who owns the opportunity. | 12345 |
priority |
JsonNullable<String> | ➖ | The priority level of the opportunity. | None |
status |
JsonNullable<String> | ➖ | The current status of the opportunity. | Open |
statusId |
JsonNullable<String> | ➖ | The unique identifier of the current status of the opportunity. | 12345 |
tags |
List<String> | ➖ | N/A | [ "New" ] |
interactionCount |
JsonNullable<Double> | ➖ | The number of interactions with the opportunity. | 0 |
customFields |
List<CustomField> | ➖ | N/A | |
stageLastChangedAt |
OffsetDateTime | ➖ | The date and time when the stage of the opportunity was last changed. | 2020-09-30T07:43:32.000Z |
lastActivityAt |
JsonNullable<String> | ➖ | The date and time of the last activity associated with the opportunity. | 2020-09-30T07:43:32.000Z |
deleted |
Optional<Boolean> | ➖ | Indicates whether the opportunity has been deleted. | false |
dateStageChanged |
OffsetDateTime | ➖ | The date and time when the stage of the opportunity was last changed. | 2020-09-30T00:00:00.000Z |
dateLastContacted |
OffsetDateTime | ➖ | The date and time when the opportunity was last contacted. | 2020-09-30T00:00:00.000Z |
dateLeadCreated |
OffsetDateTime | ➖ | The date and time when the lead associated with the opportunity was created. | 2020-09-30T00:00:00.000Z |
customMappings |
JsonNullable<CustomMappings> | ➖ | When custom mappings are configured on the resource, the result is included here. | |
updatedBy |
JsonNullable<String> | ➖ | The unique identifier of the user who last updated the opportunity. | 12345 |
createdBy |
JsonNullable<String> | ➖ | The unique identifier of the user who created the opportunity. | 12345 |
updatedAt |
OffsetDateTime | ➖ | The date and time when the opportunity was last updated. | 2020-09-30T07:43:32.000Z |
createdAt |
OffsetDateTime | ➖ | The date and time when the opportunity was created. | 2020-09-30T07:43:32.000Z |
passThrough |
List<PassThroughBody> | ➖ | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. |