Email an invoice to extra recipients

POST

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

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/invoices/example/send-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "additional_to": [ "hello@example.com" ], "additional_cc": [ "hello@example.com" ], "additional_bcc": [ "hello@example.com" ], "custom_message": "example" }'

Sends the invoice email with optional extra to, cc and bcc addresses and a custom message; does not change the status.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

additional_to

Array<string>

<= 10 items

additional_cc

Array<string>

<= 10 items

additional_bcc

Array<string>

<= 10 items

custom_message

string

<= 5000 characters

Example^generated

{
  "additional_to": [
    "hello@example.com"
  ],
  "additional_cc": [
    "hello@example.com"
  ],
  "additional_bcc": [
    "hello@example.com"
  ],
  "custom_message": "example"
}

Responses

200

OK

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