Create a proposal template

POST

/api/v1/proposal-templates

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/proposal-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "industry": "example", "deal_size_range": "small", "sections": [ { "id": "example", "title": "example", "default_content": "example", "ai_fillable": true, "ai_prompt_override": "example", "required": true, "order": 1 } ], "default_tone": "formal", "is_default": true }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 300 characters

description

string

<= 2000 characters

industry

Any of:

string

string

<= 200 characters

null

null

deal_size_range

Any of:

string

string

Allowed values: small medium large enterprise

null

null

sections

required

Array<object>

>= 1 items <= 20 items

object

id

required

string

>= 1 characters <= 100 characters

title

required

string

>= 1 characters <= 300 characters

default_content

string

<= 50000 characters

ai_fillable

boolean

ai_prompt_override

Any of:

string

string

<= 2000 characters

null

null

required

boolean

order

required

integer

default_tone

string

Allowed values: formal conversational confident concise detailed

is_default

boolean

Responses

201

The new template

Media typeapplication/json

object

template

required

object

_id

required

string

key

additional properties

any

Example^generated

{
  "template": {
    "_id": "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"
    }
  ]
}