Entry in the Do Not Call List

📘

Supported Regions and Base URLs

Scope

do-not-call-lists:manage

Body Response - Schema

200 (get a list of entries)

List with the paginated samples

ParameterTypeDescriptionRequired
per_pageintegerthe number of items per pageyes
totalintegerthe total number of itemsno
countintegerthe number of items in the pageno
pageintegerthe number of the current pageno
total_pagesintegerthe total number of pagesno
_linksobjectHAL API related links

"_links" subdivides into:

"href" (string) - address of the resource
no
_embeddedobject"_embedded" subdivides into:

1 - "entries (array[object]) - list of entries paginated. Subdivides into:

1.1 - "id" (string) - entry ID.

1.2 - "do_not_call_list_id" (string) - do not call list ID

1.3 - "phone_number" (string) - phone number of the record

1.4 - "reason" (string) - reason for the phone number is being added to do not call list

1.5 - "expiration_date" (string) - date where the DNCL entry expires

1.6 - "expiration_date" (string) - date where the dncl entry expires

1.7 - "created_at" (string) - record creation date

1.8 - "_links" (object) - record creation date
1.8.1 - "self" (object)
1.8.1.1 - "href" (string)
no

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

ParameterTypeDescriptionRequired
codestringn/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!