lists

Update List Name

Updates the name of a list.

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

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

Changed in 3 of the 5 revisions of this API.2620

  • b36e8e329afb113See the full diff
    • ▲

      the request property became required

      request-property-became-required

    • ○

      api operation id updateListName removed and replaced with updateList

      api-operation-id-removed

    • ○

      the endpoint scheme security ApiKeyAuth was removed from the API

      api-security-removed

    • ○

      api tag lists added

      api-tag-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f80fb2a115ff157See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ●

      deleted the header request parameter Content-Type

      request-parameter-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      api operation id create removed and replaced with updateListName

      api-operation-id-removed

    • ○

      the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      deleted the header request parameter Authorization

      request-parameter-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog