Resolve a set of alerts for a specific entity — FrankieOne

Request that alerts for an entity are all updated with the same information as provided in the request. You can use this operation to resolve a set of alerts for an entity.

Path parameters

entityIdstringRequired

Unique identifier of a FrankieOne entity

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-BackgroundintegerOptional

If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.

Request

This endpoint expects an object.

updateobjectOptional

Describes an update to an alert, this can be used to update status, assignment of the alert.

filterobjectOptional

Response

Response from the PATCH /entity/{entityId}/alerts endpoint

totalinteger

Total of number of items that were found to be actioned by bulk update request

successfulobject

Represents the result of a bulk update action

failedobject

Represents the result of a bulk update action

1	curl -X PATCH https://api.kycaml.uat.frankiefinancial.io/transaction/v2/entities/98ded7ac-2457-4bde-b27c-fcee05301262/alerts \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "api_key: <apiKey>" \
5	-H "Content-Type: application/json" \
6	-d '{}'

1	{
2	"total": 1,
3	"successful": {
4	"count": 1
5	},
6	"failed": {
7	"count": 1
8	}
9	}