Skip to main content
POST
/
opportunity-types
Create an opportunity type
curl --request POST \
  --url https://www.ruddr.io/api/workspace/opportunity-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isActive": true
}
'
{
  "id": "a4e8c3f1-6b72-4d95-b0e7-2f1d8a5c9047",
  "name": "New Business",
  "description": "Opportunities with first-time customers.",
  "isActive": true,
  "createdAt": "2025-03-10T14:22:45.183Z"
}
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.

Body

application/json
​
name
string
required

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. Defaults to true if not provided.

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.