---
title: "Add a custom notification for an employment"
method: POST
path: "/v2/providers/employers/employees/employments/{employmentId}/customnotifications"
tags: ["Custom notification"]
---

# Add a custom notification for an employment

`POST /v2/providers/employers/employees/employments/{employmentId}/customnotifications`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/customnotifications`
- Auth: none required

__Activity name :__ <a href="https://developer.loket.nl/Activities/PostCustomNotificationByEmploymentId" target="_blank">PostCustomNotificationByEmploymentId</a>

__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.

## Path parameters

- `employmentId` string, uuid, required

## Headers

- `Authorization` string, required
- `Accept` string, required

## Request body

- CustomNotifications
  - `id` string, uuid: The unique identifier of an object (GUID/UUID)
  - `notificationDate` string, date: The date on which the first notification occurs.
  - `expirationDate` string, date, nullable: The date on which the Notification will expire.
  - `notificationText` string: The description of the signal
  - `recurrencePattern` object, nullable: Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
    - `recurrenceNumber` integer: The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
    - `recurrencePeriod` object, nullable: The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
      - `key` integer
      - `value` string
    - `numberOfRepetitionsAfterFirstNotification` integer: The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.

## Response `201`

Created

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `content` CustomNotifications
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `notificationDate` string, date: The date on which the first notification occurs.
    - `expirationDate` string, date, nullable: The date on which the Notification will expire.
    - `notificationText` string: The description of the signal
    - `recurrencePattern` object, nullable: Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
      - `recurrenceNumber` integer: The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
      - `recurrencePeriod` object, nullable: The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
        - `key` integer
        - `value` string
      - `numberOfRepetitionsAfterFirstNotification` integer: The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)