---
title: "PATCH /abonnement/{uuid}"
method: PATCH
path: "/abonnement/{uuid}"
tags: ["abonnement"]
---

# PATCH /abonnement/{uuid}

`PATCH /abonnement/{uuid}`

## Request

- Base URL: `/api/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/abonnement/{uuid}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/vng-realisatie/apis/notificaties-api/docs/abonnement/:uuid/patch.ts> (a function with typed inputs; its response is checked against the schema)

Werk een ABONNEMENT deels bij.

## Request body

- Abonnement
  - `url` string, uri: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.
  - `callbackUrl` string, uri, required: De URL waar notificaties naar toe gestuurd dienen te worden. Deze URL dient uit te komen bij een API die geschikt is om notificaties op te ontvangen.
  - `auth` string, required: Autorisatie header invulling voor het vesturen naar de "Callback URL". Voorbeeld: Bearer a4daa31...
  - `kanalen` FilterGroup[], required: Een lijst van kanalen en filters waarop het ABONNEMENT wordt afgenomen.
    - `filters` object: Map van kenmerken (sleutel/waarde) waarop notificaties gefilterd worden. Alleen notificaties waarvan de kenmerken voldoen aan het filter worden doorgestuurd naar de afnemer van het ABONNEMENT.
    - `naam` string, required: De naam van het KANAAL (`KANAAL.naam`) waarop een abonnement is of wordt genomen.

## Response `200`

OK

- Abonnement
  - `url` string, uri: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.
  - `callbackUrl` string, uri, required: De URL waar notificaties naar toe gestuurd dienen te worden. Deze URL dient uit te komen bij een API die geschikt is om notificaties op te ontvangen.
  - `auth` string, required: Autorisatie header invulling voor het vesturen naar de "Callback URL". Voorbeeld: Bearer a4daa31...
  - `kanalen` FilterGroup[], required: Een lijst van kanalen en filters waarop het ABONNEMENT wordt afgenomen.
    - `filters` object: Map van kenmerken (sleutel/waarde) waarop notificaties gefilterd worden. Alleen notificaties waarvan de kenmerken voldoen aan het filter worden doorgestuurd naar de afnemer van het ABONNEMENT.
    - `naam` string, required: De naam van het KANAAL (`KANAAL.naam`) waarop een abonnement is of wordt genomen.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `406`: Not acceptable
- `409`: Conflict
- `410`: Gone
- `415`: Unsupported media type
- `429`: Too many requests
- `500`: Internal server error

## Changes

- **2019-09-19** `8c22f39e1b72`: 1 breaking, 1 warning
  - the `kanalen/items/filters/additionalProperties/` request property's minLength was increased from `0` to `1`
  - the `kanalen/items/filters/additionalProperties/` request property's maxLength was set to `1000`
- **2019-07-17** `9af419381458`: 1 breaking
  - the `url` request property's minLength was increased from `0` to `1`
- **2019-05-16** `0175e7c33f58`: 1 breaking, 3 info
  - removed the required property `invalid-params` from the response with the `400` status
  - the security scope `notificaties.consumeren` was added to the endpoint's security scheme `JWT-Claims`
  - the security scope `notificaties.scopes.consumeren` was removed from the endpoint's security scheme `JWT-Claims`
  - added the required property `invalidParams` to the response with the `400` status

[Operation history](https://skmtc.dev/vng-realisatie/apis/notificaties-api/changes/abonnement/:uuid/patch.md)

---

[API](https://skmtc.dev/vng-realisatie/apis/notificaties-api.md) - [All operations](https://skmtc.dev/vng-realisatie/apis/notificaties-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vng-realisatie/apis/notificaties-api/revisions/ff27778ddd2f?raw)