Send an invoice by email

POST

/api/v1/invoices/{id}/send

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

Draft invoices only. Marks the invoice as sent, then emails it. Email failures do not undo the status change; check email_sent and email_error.

Authorizations

• bearerJwt
• personalAccessToken
  write:invoices
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

to_email

Any of:

string

string format: email

string

string

message

string

<= 5000 characters

Responses

200

The sent invoice and the email outcome

Media typeapplication/json

object

invoice

required

object

_id

required

string

invoice_number

required

string

status

required

string

lead_id

required

string

lead_name

required

string | null

total

required

number

amount_paid

required

number

balance_due

required

number

key

additional properties

any

email_sent

required

boolean

email_error

string

Example^generated

{
  "invoice": {
    "_id": "example",
    "invoice_number": "example",
    "status": "example",
    "lead_id": "example",
    "lead_name": "example",
    "total": 1,
    "amount_paid": 1,
    "balance_due": 1
  },
  "email_sent": true,
  "email_error": "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"
    }
  ]
}