Notification preferences

Set a notification preference

Switches one notification on or off for the signed-in property manager. It affects that person only, and takes effect on the next notification of that kind.

PUT

https://services.magicdoor.com/communications/company-portal/notifications/preferences

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Body

application/json

One notification per call. There is no bulk form.

notificationDefinitionKeystringrequired

The notification to change, taken from List notification preferences.

enabledbooleanrequired

true to receive this notification, false to stop receiving it.

Response

200 · The setting as it now stands.

notificationDefinitionKeystringrequired

The notification that was changed.

enabledbooleanrequired

Whether it now reaches the caller.

400 · The notification is mandatory — it reports `allowUnsubscribe: false` — and cannot be switched off or on. This is returned whichever value you send.

401 · The access token is missing, expired, or not a property-manager token.

404 · No notification has that key, or the key names one aimed at tenants, owners or vendors rather than at property managers.

Request

curl --request PUT \
  --url 'https://services.magicdoor.com/communications/company-portal/notifications/preferences' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "notificationDefinitionKey": "property-manager-lease-payment-dispute-created",
  "enabled": false
}'

Body

{
  "notificationDefinitionKey": "property-manager-lease-payment-dispute-created",
  "enabled": false
}

Response

{
  "notificationDefinitionKey": "property-manager-lease-payment-dispute-created",
  "enabled": false
}