Create an opportunity

POST

/api/v1/opportunities

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/opportunities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "pipeline_id": "example", "status_id": "example", "name": "example", "value": 1, "currency": "example", "confidence": 1, "close_date": "", "note": "example", "owner_id": "example", "custom_fields": { "additionalProperty": "example" }, "forecast_category": "pipeline" }'

Authorizations

• bearerJwt
• personalAccessToken
  write:opportunities
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

lead_id

required

string

/^[0-9a-fA-F]{24}$/

pipeline_id

string

/^[0-9a-fA-F]{24}$/

status_id

string

/^[0-9a-fA-F]{24}$/

name

required

string

>= 1 characters <= 500 characters

value

number

currency

string

>= 3 characters <= 3 characters

confidence

number

<= 100

close_date

Any of:

unknown

Any of:

string

string format: date-time

string

string

/^\d{4}-\d{2}-\d{2}$/

string

string

note

string

owner_id

string

/^[0-9a-fA-F]{24}$/

custom_fields

object

key

additional properties

forecast_category

string

Allowed values: pipeline best_case commit closed omitted

Responses

201

The new opportunity

Media typeapplication/json

object

opportunity

required

object

_id

required

string

lead_id

required

string

value

required

number

is_at_risk

required

boolean

owner_name

required

string | null

key

additional properties

any

Example^generated

{
  "opportunity": {
    "_id": "example",
    "lead_id": "example",
    "value": 1,
    "is_at_risk": true,
    "owner_name": "example"
  }
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}