Update Blacklist

Updating existing Blacklist Record

PATCH /api/blacklist/{id}

Update a Blacklist record

cURL

curl --request PATCH \
  --url https://api.example.com/api/blacklist/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "reference_id": "<string>",
  "list_name": "HIGH RISK"
}
'

200

{}

Records pertaining to the blacklist can also be updated should there be a change of name or reference ID.

Authorizations

CustomAuthenticationcookieAuth

Authorization · string · header · required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

id · integer · required

A unique integer value identifying this blacklist.

Body

application/json

name · string

Blacklist name.

reference_id · string

Reference ID.

list_name · enum<string>

List name.

Available options: HIGH RISK, RESTRICTED

Response

200

application/json

Blacklist record updated successfully

Blacklist object