Skip to main content
PATCH
/
opportunity-types
/
{id}
Update an opportunity type
curl --request PATCH \
  --url https://www.ruddr.io/api/workspace/opportunity-types/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isActive": true
}
'
{
  "id": "c9f1a5e3-7d42-4b86-a0d8-e3b7c6f02d19",
  "name": "Upsell",
  "description": "Expanding services or scope with an existing client.",
  "isActive": true,
  "createdAt": "2025-04-10T11:35:42.891Z"
}
A classification used to categorize opportunities.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The opportunity type uuid.

Body

application/json
name
string

The name of the opportunity type. Max 255 characters.

description
string | null

The description of the opportunity type. Max 5000 characters.

isActive
boolean

Whether the opportunity type is active.

Response

200

id
string

The unique identifier for the object.

name
string

The name of the opportunity type.

description
string | null

The description of the opportunity type.

isActive
boolean

Whether the opportunity type is active.

createdAt
string<date-time>

The timestamp when the object was created.