Skip to main content
POST
Create an opportunity type
A classification used to categorize opportunities.

Authorizations

Authorization
string
header
required

An API key created in Settings > API Keys. Each key is either Read-Only or Full Access, chosen when the key is created. A Read-Only key can only make GET requests; POST, PATCH, and DELETE requests made with it return a 403 with the message This API key is read-only.

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.