LEleadfeeder
Lists
v1

Update List

Changed on

Update the name of a list.

Credit Note: Updating list name does not consume credits.

:::info Requires the lists:write OAuth2 scope. :::

patch/v1/lists/{id}

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/lists/{id}
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.leadfeeder.com/v1/oauth/authorize
      Token URL: https://api.leadfeeder.com/v1/oauth/token scopes: lists:write

Path parameters

idstring required

Unique identifier of the list (e.g. company_123)

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

Request body

Response

Success

Example response

{
  "data": {
    "attributes": {
      "created_at": "2024-12-10T15:57:25Z",
      "name": "US Prospects",
      "scope": "company",
      "updated_at": "2024-11-24T11:50:00Z"
    },
    "id": "company_123",
    "relationships": {
      "created_by": {
        "id": "12345"
      }
    },
    "type": "list"
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes

  • ac752c6c2be0Revision changes
    • 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

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 12ae8a6b9fadRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      added the non-success response with the status