Create a Do Not Call List

Returns a signed URL to upload a CSV file

📘

Supported Regions and Base URLs

Scope

do-not-call-lists:manage

Request Body (required)

{
  "name": "Do Not Call List 20",
  "csv_metadata": {
    "filename": "donotcalllist.csv",
    "byte_size": 413,
    "checksum": "d2c07dcf1589304317056dd7e28e32b8",
    "content_type": "text/csv"
  }
}

Body Response - Schema

201 (created do not call list and signed URL for the CSV file)

ParameterTypeDescriptionRequired
idstringID of created listno
namestringname of created listno
statusstringstatus of the CSV fileno
signed_urlstringURL used to save the CSV file in S3no
_linksobject"_links" subdivides into:

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

400 (errors were found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (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!