Update the invoice reminder schedule

PUT

/api/v1/org/invoice-reminders

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/org/invoice-reminders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "before_due_days": [ 1 ], "on_due_date": true, "after_due_days": [ 1 ], "max_reminders": 1, "stop_on_payment": true }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

enabled

boolean

before_due_days

Array<integer>

<= 10 items

on_due_date

boolean

after_due_days

Array<integer>

<= 10 items

max_reminders

integer

>= 1 <= 20

stop_on_payment

boolean

Example^generated

{
  "enabled": true,
  "before_due_days": [
    1
  ],
  "on_due_date": true,
  "after_due_days": [
    1
  ],
  "max_reminders": 1,
  "stop_on_payment": true
}

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