Do Not Call List Details

📘

Supported Regions and Base URLs

Scope

do-not-call-lists:manage

Body Response - Schema

200 (the do not call list details)

ParameterTypeDescriptionRequired
idstringID of the do not call list createdno
namestringdo not call list nameno
created_atstringdo not call list creation dateno
updated_atstringdo not call list updated dateno
statusstringStatus of validation process done on the do not call list csv file.

Allowed values:
"REJECTED",
"VALIDATION_STARTED",
"UPLOADED", "ACCEPTED", "INCOMPLETE, "CORRUPTED"
no
entries_countintegerhow many entries are present in the do not call listno
teamsarray[object]Teams that this do not call list belongs to, if any.

"teams" subdivides into:

1 - "id" (string) - the team ID of the do not call list.

2 - "name" (string) - the team name of the do not call list.

3 - "_links" (object) - the team name of the do not call list.
3.1 - "self" (object)
3.1.1 - "href" (string)
no
account_idstringaccount ID of do not call listno
_linksobject"_links" subdivides into:

1 - "self" (object)
1.1 - "href" (string)
no

401 (unauthorized), 403 (forbidden), 404 (do not call list not found)

ParameterTypeDescriptionRequired
codesstringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)
Language
Click Try It! to start a request and see the response here!