Update grouped notification preferences for the current user

PATCH

/api/notification-preferences

const url = 'https://api.getvespy.com/api/notification-preferences';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"preferences":[{"emailDelivery":"immediate","emailEnabled":true,"eventFamily":"maintenance","inAppEnabled":true,"smsEnabled":true}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.getvespy.com/api/notification-preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "preferences": [ { "emailDelivery": "immediate", "emailEnabled": true, "eventFamily": "maintenance", "inAppEnabled": true, "smsEnabled": true } ] }'

Authorizations

bearerAuth

Request Body^required

application/json

object

preferences

required

Array<object>

>= 1 items

Any of:

object

emailDelivery

string

Allowed values: immediate daily_digest

emailEnabled

boolean

eventFamily

string

Allowed values: maintenance compliance messaging statements payments leasing

inAppEnabled

required

boolean

smsEnabled

boolean

Responses

200

Default Response

application/json

object

preferences

required

Array<object>

object

emailDelivery

required

string

Allowed values: immediate daily_digest

emailEnabled

required

boolean

eventFamily

required

string

Allowed values: maintenance compliance messaging statements payments leasing

inAppEnabled

required

boolean

smsEnabled

required

boolean

Example

{
  "preferences": [
    {
      "emailDelivery": "immediate",
      "eventFamily": "maintenance"
    }
  ]
}

400

Default Response

application/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

application/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"
}

Update grouped notification preferences for the current user

Authorizations

Request Bodyrequired

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

Request Body^required

Example^generated

Example^generated