LEleadfeeder
Ideal Customer Profiles
v1

Update an Ideal Customer Profile

Changed on

Update an existing Ideal Customer Profile (ICP). All attributes are optional; only the attributes you send are changed. Sending filters replaces every category, not just the one you name.

An ICP that still uses a replaced employee range (1-2, 3-10, 11-50, 51-200 or 201-500) can't be updated, not even renamed, unless the update sends filters with current ranges. Without them the request is rejected with a 422 naming the ranges to replace.

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

patch/v1/icps/{id}

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/icps/{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: icps:write

Path parameters

idstring required

The ICP ID.

Query parameters

account_idstring required

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

Request body

Example request

{
  "data": {
    "attributes": {
      "filters": {
        "employee_count": [
          {
            "display_value": "11-100",
            "search_value": "11-100"
          }
        ],
        "industries": [
          {
            "display_value": "Software Development",
            "search_value": "1594.6.4"
          }
        ],
        "location": [
          {
            "display_value": "United States",
            "search_value": "US",
            "type": "country_code"
          }
        ]
      },
      "name": "US Tech Companies"
    },
    "type": "icp"
  }
}

Response

Success

Example response

{
  "data": {
    "attributes": {
      "created_at": "2024-12-10T15:57:25Z",
      "filters": {
        "employee_count": [
          {
            "display_value": "United States",
            "search_value": "US"
          }
        ],
        "industries": [
          {
            "display_value": "United States",
            "search_value": "US"
          }
        ],
        "location": [
          {
            "display_value": "United States",
            "search_value": "US",
            "type": "country_code"
          }
        ]
      },
      "name": "US Prospects"
    },
    "id": "6080",
    "relationships": {
      "custom_feed": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "type": "custom_feed"
      }
    },
    "type": "icp"
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes

  • ff9df8ba8977Revision changes
    • breaking

      removed the enum value 1-2 of the request property /////

    • breaking

      removed the enum value 11-50 of the request property /////

    • breaking

      removed the enum value 201-500 of the request property /////

    • breaking

      removed the enum value 3-10 of the request property /////

    • breaking

      removed the enum value 51-200 of the request property /////

    • info

      added the new 1-10 enum value to the request property /////

    • info

      added the new 101-500 enum value to the request property /////

    • info

      added the new 11-100 enum value to the request property /////

  • 09a5f5bf0a85Revision changes
    • info

      added the required property / to the response with the status