Alert - Update

PATCH

Update Alert

Path parameters

alertIdstringRequired

Request

This endpoint expects an object.

priorityenumOptional

Allowed values: P1P2P3P4

tagslist of objectsOptional

Generic key-value pair model to append a custom variable being sent to Flagright API

creationReasonobjectOptional

entityDetailsobjectOptional

assignmentslist of objectsOptional

ruleDetailsobjectOptional

Response

This endpoint returns an object.

alertIdstring

createdTimestampdouble

caseIdstring

priorityenum

Allowed values: P1P2P3P4

entityDetailsobject

ruleDetailsobject

alertStatusenum

updatedAtdouble

tagslist of objectsOptional

Generic key-value pair model to append a custom variable being sent to Flagright API

creationReasonobjectOptional

assignmentslist of objectsOptional

Errors

PATCH

1 curl -X PATCH https://sandbox.api.flagright.com/management/alerts/:alertId \
2      -H "x-api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "alertId": "string",
3   "createdTimestamp": 1,
4   "caseId": "string",
5   "priority": "P1",
6   "tags": [
7     {
8       "key": "string",
9       "value": "string"
10     }
11   ],
12   "creationReason": {
13     "reasons": [
14       "string"
15     ],
16     "comment": "string",
17     "timestamp": 1
18   },
19   "entityDetails": {
20     "type": "TRANSACTION",
21     "transactionIds": [
22       "string"
23     ]
24   },
25   "assignments": [
26     {
27       "assigneeEmail": "string",
28       "assignedByEmail": "string",
29       "timestamp": 1
30     }
31   ],
32   "ruleDetails": {
33     "id": "string",
34     "name": "string",
35     "action": "ALLOW",
36     "description": "string",
37     "instanceId": "string",
38     "nature": "AML"
39   },
40   "alertStatus": "OPEN",
41   "updatedAt": 1
42 }

Built with

1	curl -X PATCH https://sandbox.api.flagright.com/management/alerts/:alertId \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"alertId": "string",
3	"createdTimestamp": 1,
4	"caseId": "string",
5	"priority": "P1",
6	"tags": [
7	{
8	"key": "string",
9	"value": "string"
10	}
11	],
12	"creationReason": {
13	"reasons": [
14	"string"
15	],
16	"comment": "string",
17	"timestamp": 1
18	},
19	"entityDetails": {
20	"type": "TRANSACTION",
21	"transactionIds": [
22	"string"
23	]
24	},
25	"assignments": [
26	{
27	"assigneeEmail": "string",
28	"assignedByEmail": "string",
29	"timestamp": 1
30	}
31	],
32	"ruleDetails": {
33	"id": "string",
34	"name": "string",
35	"action": "ALLOW",
36	"description": "string",
37	"instanceId": "string",
38	"nature": "AML"
39	},
40	"alertStatus": "OPEN",
41	"updatedAt": 1
42	}