Create List

Copied

                https://api.ocamba.com/v2/adex/lists

Create a new List object

Request Body Schema

Name

Description

itemslist-items-by-typerequired

Items must be a string, value depends on list type. For examples check list-items-by-type or request example.

List Items

Name

Description

categorystring

Category list items must be a string of valid category IDs supported by Ocamba, separated by a comma.

Example: IAB1,IAB11,IAB3

countrystring

Country list items must be valid a string of two letter country codes supported by Ocamba, separated by a comma.

Example: RS,DE,JP,GB

domainstring

Domain list items must be a string of fully qualified domain names separated by a comma. Domain length must be between 3 and 100 characters.

Example: example.domain.com,another.example.com

ipstring

Ip list items must be a string of ip addresses in an ipv4, ipv6 or cidr format for both v4 and v6, separated by a comma.

Example: 192.168.0.1,1.1.1.1,192.168.0.15/28,1.2.3.4,2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23,2301:0db2:84a3:34a1:ff42:8a1e:0270:7324

keywordstring

String containing keywords separated by a comma. Keyword must be a string with minimum length of 3 and maximum of 150, containing max 20 groups separated by \|. Each group can be made up of these characters: a-zA-Z0-9_%!

Example: keyword01!\|keyword02_%,example_keyword|another_example

regionstring

Region list item must be a string of region IDs supported by Ocamba, separated by a comma.

Example: 292969,3183560,7581800

subidstring

String containing subids separated by a comma. Subid can be any string with length between 1 and 200 characters.

Example: subid_1,subid2,sub_id_3

zonestring

Zone list items must be a string of valid zone IDs supported by Ocamba, separated by a comma.

Example: 1314550,1445589,1332565

namestringrequired

Represents name of the list.

Example: demo_list

typestringrequired

Response status codes

201 - Created

Request examples

Copied

country

country
category
domain
ip
keyword
subid
zone
region

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "country",
  "items": "RS,GB,DE,JP,US"
}

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "category",
  "items": "IAB1,IAB11,IAB3"
}

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "domain",
  "items": "example.domain.com,another.example.com"
}

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "ip",
  "items": "192.168.0.1,1.1.1.1,192.168.0.15/28,1.2.3.4"
}

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "keyword",
  "items": "keyword01!\|keyword02_%,example_keyword|another_example"
}

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "subid",
  "items": "subid_1,subid2,sub_id_3"
}

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "zone",
  "items": "1314550,1445589,1332565"
}

{
  "account_id": "93662681",
  "name": "demo_name",
  "type": "region",
  "items": "292969,3183560,7581800"
}

Response examples

Copied

201

{
    "id": "3832",
    "company_id": "1331441",
    "account_id": "93662681",
    "name": "demo_name",
    "type": "country",
    "items": "RS,GB,DE,JP,US"
}

Create List

POST /listsCopied https://api.ocamba.com/v2/adex/lists

POST /lists
Copied
`https://api.ocamba.com/v2/adex/lists`