Dismiss an alert

Dismisses a specific alert.

Request

path Parameters

alertId

required

string <uuid>

Identifier of the alert to dismiss.

Request Body schema: application/json

dismissalNote

string

A note that explains why this alert was dismissed.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Server Error

post/alerts/{alertId}/dismiss

Request samples

Payload

application/json

{"dismissalNote": "string"
}

Response samples

application/json

{"type": "LicenseChanged",
"providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
"provider": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"credentialingStatus": "string",
"credentialedDate": "2019-08-24T14:15:22Z",
"nextCredentialingDate": "2019-08-24",
"npi": 0,
"deactivated": true,
"deactivatedAt": "2019-08-24T14:15:22Z",
"aliases": [{"firstName": "string",
"lastName": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"addresses": [{"state": "AL",
"zipCode": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"type": "Unspecified",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"emails": [{"email": "string",
"type": "Unspecified",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"phone": "string",
"languages": ["string"
],
"recredentialedDates": ["2019-08-24T14:15:22Z"
],
"providerType": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
},
"entityType": "License",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"data": {"messageTemplate": "string",
"messageParams": {"property1": "string",
"property2": "string"
},
"data": {"property1": "string",
"property2": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"dismissalTimestamp": "2019-08-24T14:15:22Z",
"dismissalNote": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}