Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Create a proposal

POST
/api/v1/proposals
curl --request POST \
  --url https://api.pitch2sale.com/api/v1/proposals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "opportunity_id": "example", "name": "example", "sections": [ { "id": "example", "title": "example", "content": "example", "order": 1 } ], "template_id": "example" }'

Created as a draft on a lead.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
lead_id
required
string
/^[0-9a-fA-F]{24}$/
opportunity_id
string
/^[0-9a-fA-F]{24}$/
name
required
string
>= 1 characters <= 500 characters
sections
Array<object>
object
id
required
string
>= 1 characters
title
required
string
>= 1 characters
content
required
string
order
required
integer
template_id
string
/^[0-9a-fA-F]{24}$/
Examplegenerated
{
  "lead_id": "example",
  "opportunity_id": "example",
  "name": "example",
  "sections": [
    {
      "id": "example",
      "title": "example",
      "content": "example",
      "order": 1
    }
  ],
  "template_id": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

The new proposal

Media typeapplication/json
object
proposal
required
object
_id
required
string
name
required
string
status
required
string
lead_id
required
string
currency
required
string
public_token
required
string | null
key
additional properties
any
Examplegenerated
{
  "proposal": {
    "_id": "example",
    "name": "example",
    "status": "example",
    "lead_id": "example",
    "currency": "example",
    "public_token": "example"
  }
}

400

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}