lists

Modify List

Changed on Dec 5, 2024

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

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

Request

Base URL
https://search.grata.com
Auth
API key in header Authorization

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

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"
    ]
  }
}

Changes

Dec 5, 2024b36e8e329afb Revision changes
- breaking
  the request property became required
- info
  the endpoint scheme security ApiKeyAuth was removed from the API
- info
  api tag lists added
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property // became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
Dec 5, 2024f80fb2a115ff Revision changes
- breaking
  request body became required
- warning
  deleted the header request parameter Content-Type
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- info
  api operation id post removed and replaced with modifyList
- info
  the endpoint scheme security ApiKeyAuth was added to the API
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history (3 revisions)