Send a proposal by email

POST

/api/v1/proposals/{id}/send

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/proposals/example/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "to_email": "hello@example.com", "to": "hello@example.com", "recipient_email": "hello@example.com", "subject": "example", "message": "example" }'

Draft proposals only. Marks the proposal as sent and emails the public link to to_email or, by default, the lead’s primary contact.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

to_email

string format: email

to

string format: email

recipient_email

string format: email

subject

string

<= 500 characters

message

string

<= 5000 characters

Example^generated

{
  "to_email": "hello@example.com",
  "to": "hello@example.com",
  "recipient_email": "hello@example.com",
  "subject": "example",
  "message": "example"
}

Responses

200

The sent proposal and the email outcome

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

email_sent

required

boolean

email_reason

required

string | null

Example^generated

{
  "proposal": {
    "_id": "example",
    "name": "example",
    "status": "example",
    "lead_id": "example",
    "currency": "example",
    "public_token": "example"
  },
  "email_sent": true,
  "email_reason": "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"
    }
  ]
}

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"
    }
  ]
}