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.

Update the invoice email templates

PUT
/api/v1/org/invoice-emails
curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/org/invoice-emails \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "send": { "subject": "example", "body": "example", "enabled": true }, "reminder": { "subject": "example", "body": "example", "enabled": true }, "overdue": { "subject": "example", "body": "example", "enabled": true }, "thank_you": { "subject": "example", "body": "example", "enabled": true }, "cc_emails": [ "hello@example.com" ], "bcc_emails": [ "hello@example.com" ], "reply_to": "hello@example.com", "from_name": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
send
object
subject
required
string
>= 1 characters <= 500 characters
body
required
string
>= 1 characters <= 50000 characters
enabled
required
boolean
reminder
object
subject
required
string
>= 1 characters <= 500 characters
body
required
string
>= 1 characters <= 50000 characters
enabled
required
boolean
overdue
object
subject
required
string
>= 1 characters <= 500 characters
body
required
string
>= 1 characters <= 50000 characters
enabled
required
boolean
thank_you
object
subject
required
string
>= 1 characters <= 500 characters
body
required
string
>= 1 characters <= 50000 characters
enabled
required
boolean
cc_emails
Array<string>
<= 10 items
bcc_emails
Array<string>
<= 10 items
reply_to
Any of:
string format: email
<= 255 characters
from_name
Any of:
string
<= 200 characters
Examplegenerated
{
  "send": {
    "subject": "example",
    "body": "example",
    "enabled": true
  },
  "reminder": {
    "subject": "example",
    "body": "example",
    "enabled": true
  },
  "overdue": {
    "subject": "example",
    "body": "example",
    "enabled": true
  },
  "thank_you": {
    "subject": "example",
    "body": "example",
    "enabled": true
  },
  "cc_emails": [
    "hello@example.com"
  ],
  "bcc_emails": [
    "hello@example.com"
  ],
  "reply_to": "hello@example.com",
  "from_name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

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