FOfolk
Views

Update a view

Changed on

Update the settings of a view of a group, or of one of your personal views. Only the settings sent are changed; filter, visibleFields, sort and columns replace the current value. A view never changes group, entity type or type.

patch/v1/views/{viewId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/views/{viewId}
  • Auth
    HTTP bearer

Path parameters

viewIdstring required

The ID of the view to update.

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

namestring
visibleFieldsstring[]

The fields shown by the view, in display order, with the same keys as the filter, at most 100. The name column is always shown and is never listed.

groupBystring

Kanban views only. Without columns, the columns are kept when the field is the current one, and reset to the options of the new field otherwise, with the "No value" column hidden if it was.

Example request

{
  "filter": {
    "conditions": [
      {
        "field": "jobTitle",
        "operator": "like"
      }
    ]
  },
  "visibleFields": [
    "jobTitle",
    "companies",
    "emails"
  ],
  "sort": {
    "field": "interactionMetadata.user.lastInteractedAt"
  },
  "groupBy": "customFieldValues.grp_92ab3f1c-0386-434d-82d7-a91eb6badd71.Stage",
  "columns": [
    {
      "option": "Qualified"
    }
  ]
}

Response

The updated view.

deprecationsstring[]

Example response

{
  "data": {
    "id": "viw_3f1c9a2e-0386-434d-82d7-a91eb6badd71",
    "groupId": "grp_92ab3f1c-0386-434d-82d7-a91eb6badd71",
    "name": "Hot leads",
    "entityType": "person",
    "filter": {
      "combinator": "and",
      "conditions": [
        {
          "field": "interactionMetadata.workspace.lastInteractedAt",
          "operator": "gt",
          "value": "30-days-ago"
        }
      ]
    },
    "visibleFields": [
      "jobTitle",
      "companies",
      "emails"
    ],
    "position": {
      "after": "viw_1b2c3d4e-0386-434d-82d7-a91eb6badd71"
    },
    "createdAt": "2025-07-17T09:00:00.000Z",
    "createdBy": {
      "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
      "fullName": "John Doe",
      "email": "john.doe@example.com"
    },
    "type": "table",
    "sort": {
      "field": "interactionMetadata.user.lastInteractedAt",
      "direction": "desc"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes