Update Multiple Entries

Inside a Do Not Call list

📘

Supported Regions and Base URLs

Scope

do-not-call-lists:manage

Request Body (required)

[
  {
    "op": "replace",
    "path": "/c45f361f-2944-4844-8a21-dbfe7b000b2a/expiration_date",
    "value": "2022-12-01"
  },
  {
    "op": "replace",
    "path": "/c45f361f-2944-4844-8a21-dbfe7b000b2b/expiration_date",
    "value": "2022-12-15"
  },
  {
    "op": "replace",
    "path": "/c45f361f-2944-4844-8a21-dbfe7b000b2c/expiration_date",
    "value": "2022-12-30"
  }
]

Body Response - Schema

200 (multiple entries updated)

Response for multiple entries updated

ParameterTypeDescriptionRequired
do_not_call_list_idstringdo not call list IDno
has_errorsbooleantrue if entries updated has errorsno
total_errorsintegerTotal number of errors found in the multiple entries updated.
>= 0
<= 100
no
total_updatedintegerTotal number of entries updated in multiple entries request.
>= 0
<= 100
no
_linksobject"_links" subdivides into:

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

2 - "do_not_call_list" (object)
2.1 - "href" (string)
no
_embeddedobjectList of entries resulted from updates.

1 - "entries" (array[object])

1.1 - "id" (string)

1.2 - "do_not_call_list_id
" (string)


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

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 - "created_at" (string) - entry creation date

1.7 - errors (array[string]) -allowed values: "EXPIRATION_DATE_INVALID", "ENTRY_NOT_FOUND"

1.8 - un_allowed_patch
(object)

1.8.1 - op (string)
1.8.2 - path (string)
1.8.3 - value (string)

1.9 - "_links" (object)
1.9.1 - "self" (object)
1.9.1.1 - "href" (string)
1.9.2 - "do_not_call_list" (string)
1.9.2.1 - "href" (string)
no
Language
Click Try It! to start a request and see the response here!