Provider notification settings

Manage the Provider notification settings

Activity name : <a href="https://developer.loket.nl/Activities/PatchProviderNotificationSettingsByProviderId" target="_blank">PatchProviderNotificationSettingsByProviderId</a>

Manage the Provider notifications.

Only the changes supplied are processed. Existing records not supplied in the request body will be left unchanged. e.g. If three notifications are enabled and a patch is performed with in the body one new notification with the isEnabled = true. The result will be 4 enabled notifications.

patch/v2/providers/{providerId}/notificationsettings

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/{providerId}/notificationsettings
  • Auth
    none required

Path parameters

providerIdstring uuid required

The unique identifier of an provider

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

createNumberOfDaysBeforeEventinteger

The number of days that the notification is created before the event takes place.

isEnabledboolean

Enable or disable a notification for the provider

Example request

[
  {
    "notificationType": {
      "key": 3,
      "value": "Start of employment"
    },
    "createNumberOfDaysBeforeEvent": 30
  }
]

Response

OK

contentobject

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.