Update a Single Entry

Inside a Do Not Call list

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

do-not-call-lists:manage

Request Body (required)

[
  {
    "op": "replace",
    "path": "/expiration_date",
    "value": "2022-11-30"
  }
]

Body Response - Schema

200 (entry updated)

ParameterTypeDescriptionRequired
idstringentry IDno
do_not_call_list_idstringdo not call list IDno
phone_numberstringphone number of the recordno
reasonstringreason for the phone number is being added to DNCL (Do Not Call List)no
expiration_datestringdate where the DNCL entry expiresno
created_atstringrecord creation dateno
_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 (entry not found), 422 (unprocessable entity)

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

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!