AddScrubListEntries

POST

https://api.cbf.tcn.com/api/v0alpha/compliance/addscrublistentries

Add entries to an existing scrub list defined by AddScrubListEntriesReq message.
The method will return a ScrubListRes message that will
contain the results.
Required permissions:
PERMISSION_COMPLIANCE or PERMISSION_AGENT_COMPLIANCE_SCRUBLIST_OPTIONS

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "list_id": "string",
    "list": [
        "string"
    ],
    "content_type": "CT_PHONE_NUMBER",
    "country_code": "string",
    "scrub_entry_details": [
        {
            "content": "string",
            "expiration_date": "1s",
            "notes": "string"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/compliance/addscrublistentries' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "list_id": "string",
    "list": [
        "string"
    ],
    "content_type": "CT_PHONE_NUMBER",
    "country_code": "string",
    "scrub_entry_details": [
        {
            "content": "string",
            "expiration_date": "1s",
            "notes": "string"
        }
    ]
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "list_id": "string",
    "read_only": true,
    "content_type": "CT_PHONE_NUMBER",
    "entries_added": 0,
    "invalid_entries": [
        "string"
    ],
    "total_invalid": 0,
    "invalid_list": [
        {
            "entry": "string",
            "error_message": "string"
        }
    ],
    "country_code": "string",
    "decompositions": {
        "items": [
            {
                "name": "string",
                "start_digit": 0,
                "end_digit": 0
            }
        ]
    }
}

🟢200Success

Modified at 2025-09-26 15:44:58

UpdateScrubList

UpdateScrubEntry