Update organization notification settings

PATCH

/api/settings/notification-settings

curl --request PATCH \
  --url https://api.getvespy.com/api/settings/notification-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "rentReminders": { "channels": [ "email" ], "daysAfterDue": [ 1 ], "daysBeforeDue": [ 1 ], "enabled": true } }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

rentReminders

required

Any of:

object

object

channels

Array<string>

>= 1 items <= 2 items

Allowed values: email sms

daysAfterDue

Array<integer>

<= 10 items

daysBeforeDue

Array<integer>

<= 10 items

enabled

required

boolean

object

object

channels

Array<string>

>= 1 items <= 2 items

Allowed values: email sms

daysAfterDue

Array<integer>

<= 10 items

daysBeforeDue

required

Array<integer>

<= 10 items

enabled

boolean

object

object

channels

Array<string>

>= 1 items <= 2 items

Allowed values: email sms

daysAfterDue

required

Array<integer>

<= 10 items

daysBeforeDue

Array<integer>

<= 10 items

enabled

boolean

object

object

channels

required

Array<string>

>= 1 items <= 2 items

Allowed values: email sms

daysAfterDue

Array<integer>

<= 10 items

daysBeforeDue

Array<integer>

<= 10 items

enabled

boolean

Responses

200

Default Response

Media typeapplication/json

object

settings

required

object

createdAt

required

string format: date-time

id

required

string format: uuid

organizationId

required

string format: uuid

rentReminders

required

object

channels

required

Array<string>

>= 1 items <= 2 items

Allowed values: email sms

daysAfterDue

required

Array<integer>

<= 10 items

daysBeforeDue

required

Array<integer>

<= 10 items

enabled

required

boolean

updatedAt

required

string format: date-time

Example

{
  "settings": {
    "rentReminders": {
      "channels": [
        "email"
      ]
    }
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}