Skip to navigation

Add contacts to a notification configuration

View as MarkdownOpen in Claude

Adds the contacts you list in contacts to a notification configuration, so they receive its notifications. It only adds: contacts already in the configuration stay, and none is ever removed.

The answer arrives at once, in the same form as “Add websites to a notification configuration” but with contacts in place of websites. A contact already in the configuration is reported in meta.skipped with the reason_code ALREADY_APPLIED.

Body

  • contacts (array of integers, required): ids of the contacts to add, 1 to 50. Each must be an existing contact; a client id is refused.

Errors

  • 422: contacts is missing, empty, has more than 50 ids or contains an id that is not a contact. The body is checked before the configuration, so a configuration of another organization answers 404 only when the body is valid.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

alert_idstringRequired

Request

This endpoint expects an object.
contactslist of doublesOptional

Response

200 - Contact added, one skipped

jsonapiobjectOptional
metaobjectOptional

Errors

422
Unprocessable Entity Error