TJtjc-lp
lists

Update List Name

Changed on

Updates the name of a list.

patch/api/v1.4/lists/{list_uid}/

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

namestring required

New name of the list.

Example request

{
  "name": "New List Name"
}

Response

OK

namestring required

Name of the list.

list_uidstring required

UID of the list.

created_datestring date-time required

Date the list was created.

updated_datestring date-time required

Date the list was last updated.

company_countinteger required

Number of companies in the list.

Example response

{
  "name": "List A",
  "list_uid": "QE5XDQEB",
  "created_date": "2024-05-13T16:25:17.065916Z",
  "updated_date": "2024-06-17T07:15:59.708119Z",
  "company_count": 3
}

Changes

  • b36e8e329afbRevision changes
    • breaking

      the request property became required

    • info

      api operation id updateListName removed and replaced with updateList

    • 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

  • f80fb2a115ffRevision 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

    • info

      api operation id create removed and replaced with updateListName

    • 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