Skip to content
vocapable.Docs

Open an opportunity with a customer

POST
/v1/workspace/opportunities
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/opportunities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "organization_id": "example", "title": "example", "stage": "new", "amount_minor": 0, "currency": "USD", "need": "example", "next_step": "example", "next_step_due_at": "2026-04-15T12:00:00Z", "primary_contact_id": "example", "owner_user_id": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceOpportunityCreate
object
organization_id
required
Organization Id
string
title
required
Title
string
>= 1 characters <= 200 characters
stage
Stage
string
default: new
Allowed values: new qualified proposal won lost deferred
amount_minor
Amount Minor
integer
0
currency
Currency
string
default: USD /^[A-Z]{3}$/
need
Any of:
string
<= 4000 characters
next_step
Any of:
string
<= 500 characters
next_step_due_at
Any of:
string format: date-time
primary_contact_id
Any of:
string
owner_user_id
Any of:
string

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceOpportunity
object
id
required
Id
string
organization_id
required
Organization Id
string
organization_name
required
Organization Name
string
primary_contact_id
required
Any of:
string
owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
title
required
Title
string
stage
required
Stage
string
Allowed values: new qualified proposal won lost deferred
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
need
required
Any of:
string
next_step
required
Any of:
string
next_step_due_at
required
Any of:
string format: date-time
lost_reason
required
Any of:
string
deferred_until
required
Any of:
string format: date-time
closed_at
required
Any of:
string format: date-time
source
required
Any of:
string
accepted_scope
required
Any of:
string
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
reopened_from_id
Any of:
string
amends_id
Any of:
string
scope_accepted_at
Any of:
string format: date-time
scope_accepted_by
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
scope_acceptance_id
Any of:
string
Example
{
  "stage": "new"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}