OCocean
Exclusion Lists

Add items to exclusion list

Changed on

Add people (LinkedIn handles) or companies (domains) to an exclusion list. Creates a new list when listId is omitted. Items are company domains in a companies list and LinkedIn handles in a people list. A URL is reduced to its domain or LinkedIn handle (https://www.linkedin.com/in/john-doe/ is stored as john-doe). Each request accepts up to 10,000 items. A list holds up to 300,000 items, or your plan's exclusion limit if it is lower. A request that would take the list past that limit returns a 400 and adds nothing.

post/v2/exclusion-lists/items

Request

  • Base URL
    https://api.ocean.io
  • URL
    https://api.ocean.io/v2/exclusion-lists/items
  • Auth
    none declared

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

type'people' | 'companies' required

Whether the list holds people or companies.

listIdstring nullable

List to add items to. A new list is created when omitted.

itemsstring[] required

Company domains or LinkedIn handles to add, up to 10,000 per request. Items are company domains in a companies list and LinkedIn handles in a people list. A URL is reduced to its domain or LinkedIn handle (https://www.linkedin.com/in/john-doe/ is stored as john-doe).

Example request

{
  "type": "companies",
  "listId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "items": [
    "ocean.io",
    "stripe.com"
  ]
}

Response

Successful Response

listIdstring required

Unique id of the list.

Example response

{
  "listId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Changes