patch /v2/exclusion-lists/{list_id}

Edit exclusion list

Rename an exclusion list.

Authorizations

apiToken string

x-api-token string

Path parameters

list_id string Required

Body application/json

name string Required

New display name for the list.

Responses

200 Successful Response

any

400 Bad Request

detail enum Required

"Conflicting API tokens provided in query parameters and headers"

402 Payment Required

detail enum Required

"Insufficient email credits"

"Some email verifications are already in progress and might use all your remaining email credits. Please try again later."

"Insufficient phone credits"

"Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later."

"Insufficient credits"

403 Forbidden

detail enum Required

"API token should be provided in headers or query parameters""Current API token is not registered in our database"

404 Not found

422 Validation Error

Array of ValidationError

Array of string | integer

string | integer

msg string Required

type string Required

input any

object

429 Too Many Requests

detail string Required

API token

Session only — cleared when you close the tab.

Request

cURL

Python

JavaScript

JSON

curl -X PATCH 'https://api.ocean.io/v2/exclusion-lists/{list_id}' \
  -H 'x-api-token: <YOUR_API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated list name"
  }'

Response

400

402

403

422

429

{
  "detail": "Conflicting API tokens provided in query parameters and headers"
}