Update an opportunity

curl --request PATCH \
  --url https://www.ruddr.io/api/workspace/opportunities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "companyId": "<string>",
  "opportunityStageId": "<string>",
  "description": "<string>",
  "nextSteps": "<string>",
  "amount": 123,
  "isActive": true,
  "probability": 123,
  "closeDate": "2023-12-25",
  "priorityId": "high",
  "currency": "<string>",
  "ownerId": "<string>",
  "opportunityLeadSourceId": "<string>",
  "opportunityTypeId": "<string>",
  "tagIds": [
    "<string>"
  ],
  "practiceId": "<string>",
  "projects": [
    {
      "id": "<string>",
      "amount": 123
    }
  ],
  "cloudFolderUrl": "<string>"
}
'

{
  "id": "7bcf2403-c6ea-4f9a-a9fa-bfa53a0d43b8",
  "name": "Acme Corp - Mobile App",
  "description": "Proposal for a new mobile application.",
  "nextSteps": "Follow up with client on proposal.",
  "amount": 50000,
  "isActive": true,
  "probability": 0.75,
  "priorityId": "high",
  "createdAt": "2025-01-15T20:47:03.284Z",
  "openDate": "2025-01-15",
  "closeDate": "2025-06-30",
  "modifiedAt": "2025-01-15T20:47:03.284Z",
  "currency": "USD",
  "cloudFolderUrl": "https://drive.google.com/drive/folders/abc123",
  "owner": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "John Davis"
  },
  "opportunityType": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "New Business"
  },
  "opportunityLeadSource": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Referral"
  },
  "company": {
    "id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
    "name": "Acme Corp",
    "client": {
      "id": "e5f6a7b8-c9d0-1234-5678-9abcdef01234",
      "key": "acme-corp",
      "name": "Acme Corp"
    }
  },
  "practice": {
    "id": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
    "name": "Consulting"
  },
  "tags": [
    {
      "id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
      "name": "Enterprise"
    }
  ],
  "opportunityStage": {
    "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
    "name": "Proposal",
    "statusId": "open"
  },
  "projects": [
    {
      "id": "3c4d5e6f-7a8b-9012-cdef-123456789012",
      "name": "Mobile App Development",
      "amount": 50000
    }
  ],
  "weightedAmount": 37500,
  "timeSpent": 120,
  "salesforceId": "0060b00000BkFxAAAV",
  "hubspotId": "12345678"
}

PATCH

opportunities

{id}

Update an opportunity

curl --request PATCH \
  --url https://www.ruddr.io/api/workspace/opportunities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "companyId": "<string>",
  "opportunityStageId": "<string>",
  "description": "<string>",
  "nextSteps": "<string>",
  "amount": 123,
  "isActive": true,
  "probability": 123,
  "closeDate": "2023-12-25",
  "priorityId": "high",
  "currency": "<string>",
  "ownerId": "<string>",
  "opportunityLeadSourceId": "<string>",
  "opportunityTypeId": "<string>",
  "tagIds": [
    "<string>"
  ],
  "practiceId": "<string>",
  "projects": [
    {
      "id": "<string>",
      "amount": 123
    }
  ],
  "cloudFolderUrl": "<string>"
}
'

{
  "id": "7bcf2403-c6ea-4f9a-a9fa-bfa53a0d43b8",
  "name": "Acme Corp - Mobile App",
  "description": "Proposal for a new mobile application.",
  "nextSteps": "Follow up with client on proposal.",
  "amount": 50000,
  "isActive": true,
  "probability": 0.75,
  "priorityId": "high",
  "createdAt": "2025-01-15T20:47:03.284Z",
  "openDate": "2025-01-15",
  "closeDate": "2025-06-30",
  "modifiedAt": "2025-01-15T20:47:03.284Z",
  "currency": "USD",
  "cloudFolderUrl": "https://drive.google.com/drive/folders/abc123",
  "owner": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "John Davis"
  },
  "opportunityType": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "New Business"
  },
  "opportunityLeadSource": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Referral"
  },
  "company": {
    "id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
    "name": "Acme Corp",
    "client": {
      "id": "e5f6a7b8-c9d0-1234-5678-9abcdef01234",
      "key": "acme-corp",
      "name": "Acme Corp"
    }
  },
  "practice": {
    "id": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
    "name": "Consulting"
  },
  "tags": [
    {
      "id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
      "name": "Enterprise"
    }
  ],
  "opportunityStage": {
    "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
    "name": "Proposal",
    "statusId": "open"
  },
  "projects": [
    {
      "id": "3c4d5e6f-7a8b-9012-cdef-123456789012",
      "name": "Mobile App Development",
      "amount": 50000
    }
  ],
  "weightedAmount": 37500,
  "timeSpent": 120,
  "salesforceId": "0060b00000BkFxAAAV",
  "hubspotId": "12345678"
}

A potential business deal within a company, typically with an associated revenue value and sales details like stage, owner, probability, and expected close date.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The opportunity uuid

Body

application/json

name

string

The name of the opportunity (max 255 chars).

companyId

string

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

opportunityStageId

string

The opportunity stage ID (uuid) of the opportunity stage associated with this opportunity.

description

string

The opportunity description (max 5000 chars).

nextSteps

string

The next steps of the opportunity (max 255 chars).

amount

number<float>

The amount of the opportunity.

isActive

boolean

Whether the opportunity is active.

probability

number<float>

Percentage chance of the opportunity progressing to a successful conclusion. Accepts a value of 0 to 1 using a maximum of four decimals.

closeDate

string<date>

The close date (YYYY-MM-DD) of the opportunity.

priorityId

enum<string>

The priority of the opportunity. Possible values are: "high" (High), "medium" (Medium) or "low" (Low).

Available options:

high,

medium,

low

currency

string

The 3-letter currency code associated with the opportunity. Will default to the workspace setting if not supplied.

ownerId

string

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

opportunityLeadSourceId

string

The opportunity lead source ID (uuid) of the opportunity lead source associated with this opportunity.

opportunityTypeId

string

The opportunity type ID (uuid) of the opportunity type associated with this opportunity.

tagIds

string[]

A list of opportunity tag IDs (uuid) associated with this opportunity.

practiceId

string

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

projects

object[]

The list of the projects associated with this opportunity. IDs must be unique.

Show child attributes

cloudFolderUrl

string

The cloud folder URL (max 1024 characters).

Response

200

string

The unique identifier for the object.

name

string

The name of the opportunity (max 255 chars).

description

string | null

The opportunity description (max 5000 chars).

nextSteps

string | null

The next steps of the opportunity (max 255 chars).

amount

number | null

The amount of the opportunity.

isActive

boolean

Whether the opportunity is active.

probability

number

Percentage chance of the opportunity progressing to a successful conclusion. Accepts a value of 0 to 1 using a maximum of four decimals.

priorityId

enum<string> | null

The priority of the opportunity. Possible values are: "high" (High), "medium" (Medium) or "low" (Low).

Available options:

high,

medium,

low

createdAt

string<date-time>

The timestamp when the object was created.

openDate

string<date> | null

The open date (YYYY-MM-DD) of the opportunity.

closeDate

string<date> | null

The close date (YYYY-MM-DD) of the opportunity.

modifiedAt

string<date-time>

The date and time the record was last modified (ISO 8601).

currency

string

The 3-letter currency code associated with the opportunity. Will default to the workspace setting if not supplied.

cloudFolderUrl

string | null

The cloud folder URL (max 1024 characters).

owner

object

The owner of the opportunity.

Show child attributes

opportunityType

object

The opportunity type.

Show child attributes

opportunityLeadSource

object

The opportunity lead source.

Show child attributes

company

object

The company associated with this opportunity.

Show child attributes

practice

object

The practice associated with this opportunity.

Show child attributes

Projects

Time

Pipeline

Expenses

Resourcing

Billing

Workspace

Members

Custom Data

Update an opportunity

Authorizations

Path Parameters

Body

Response