Sign in

v5

latestOpenAPI 3.1.0raw.githubusercontent.com2024-12-05103351.8 KB
lists

Modify List

Allows users to add or remove companies from an existing list.

post/api/v1.4/lists/{list_uid}/companies/

Path parameters

list_uidstring required

The UID of the list.

Request body

action'add' | 'remove' required

The action to perform.

domainsstring[]

Domains to add or remove from a list (max of 500 permitted per call).

uidsstring[]

Grata company UIDs to add or remove from a list (max of 500 permitted per call).

Example request

{
  "domains": [
    "grata.com"
  ],
  "uids": [
    "A4Q67R3Z"
  ]
}

Response

OK

Example response

{
  "results": [
    {
      "input": "grata.com",
      "processed": true,
      "company": {
        "domain": "grata.com",
        "uid": "A4Q67R3Z"
      }
    }
  ],
  "processed": {
    "count": 1,
    "companies": [
      "grata.com"
    ]
  },
  "not_processed": {
    "count": 1,
    "companies": [
      "grata.com"
    ]
  }
}