Opportunities

Update an opportunity

patch/opportunities/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/opportunities/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The opportunity uuid

Request body

namestring

The name of the opportunity. Max 255 characters.

descriptionstring nullable

A description of the opportunity. Max 5000 characters.

nextStepsstring nullable

The next steps for the opportunity. Max 255 characters.

amountnumber nullable

The monetary amount of the opportunity.

probabilitynumber

The probability of the opportunity closing successfully. Accepts a value of 0 to 1 using a maximum of four decimals.

priorityId'high' | 'medium' | 'low' nullable

The priority of the opportunity.

openDatestring date

The open date of the opportunity in YYYY-MM-DD format.

closeDatestring date nullable

The expected close date of the opportunity in YYYY-MM-DD format.

currencystring

The 3-letter currency code for the opportunity.

cloudFolderUrlstring nullable

A URL to a cloud folder associated with the opportunity. Max 1024 characters.

ownerIdstring nullable

The member ID (uuid) of the owner of the opportunity.

opportunityLeadSourceIdstring nullable

The ID (uuid) of the lead source for the opportunity.

opportunityTypeIdstring nullable

The ID (uuid) of the opportunity type.

tagIdsstring[]

A list of opportunity tag IDs (uuid) to associate with the opportunity.

practiceIdstring nullable

The ID (uuid) of the practice associated with the opportunity.

businessUnitIdstring nullable

The ID (uuid) of the business unit associated with the opportunity.

companyIdstring

The ID (uuid) of the company associated with the opportunity.

opportunityStageIdstring

The ID (uuid) of the opportunity stage.

opportunityPipelineIdstring

The ID (uuid) of the opportunity pipeline.

Response

200

idstring

The unique identifier for the object.

namestring

The name of the opportunity.

descriptionstring nullable

A description of the opportunity.

nextStepsstring nullable

The next steps for the opportunity.

amountnumber nullable

The monetary amount of the opportunity.

probabilitynumber

The probability of the opportunity closing successfully, expressed as a decimal between 0 and 1.

priorityId'high' | 'medium' | 'low' nullable

The priority level of the opportunity.

createdAtstring date-time

The timestamp when the object was created.

openDatestring date

The date the opportunity was opened. Will be in the form YYYY-MM-DD.

closeDatestring date nullable

The expected close date for the opportunity. Will be in the form YYYY-MM-DD.

modifiedAtstring date-time

The timestamp when the object was last modified.

currencystring

The 3-letter currency code for the opportunity.

cloudFolderUrlstring nullable

A URL to a cloud folder associated with the opportunity.

weightedAmountnumber nullable

The probability-weighted amount, calculated as amount multiplied by probability.

timeSpentinteger

Total time spent in minutes across all pipeline activities.

salesforceIdstring nullable

The Salesforce opportunity ID. Will be null unless synced via the Salesforce integration.

hubspotIdstring nullable

The HubSpot deal ID. Will be null unless synced via the HubSpot integration.

Changes

No recorded changes to this operation across all 1 revision of this API.