Notification sets

Create a notification set for an provider

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

Create a notification set.

post/v2/providers/{providerId}/notificationsets

Request

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

Path parameters

providerIdstring uuid required

The unique identifier of a 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

idstring uuid

The unique identifier of an object (GUID/UUID)

descriptionstring
numberOfLinkedEmployerUsersinteger

The number of employer users that are linked to this notification set

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "description": "Salarisadministrateur",
  "numberOfLinkedEmployerUsers": 435,
  "notifications": [
    {
      "notificationType": {
        "key": 3,
        "value": "Start of employment"
      },
      "createNumberOfDaysBeforeEvent": 30
    }
  ]
}

Response

Created

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "description": "Salarisadministrateur",
    "numberOfLinkedEmployerUsers": 435,
    "notifications": [
      {
        "notificationType": {
          "key": 3,
          "value": "Start of employment"
        },
        "createNumberOfDaysBeforeEvent": 30
      }
    ]
  }
}

Changes

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