Update CRM view

PATCH/v1/crm/views/{viewID}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

viewIDstringrequired

Request body

requiredapplication/json

columnsCRMViewColumn[] | null

Show properties

Array of CRMViewColumn

fieldstringrequired

hiddenboolean

labelstring

pinnedstring

positioninteger<int32>

sourcestring

widthinteger<int32>

descriptionstring

display_typestring

Allowed:tablekanbancalendar

filtersCRMRecordFilter[] | null

Show properties

Array of CRMRecordFilter

fieldstringrequired

operatorstring

sourcestring

valueany

group_byCRMViewGroupBy[] | null

Show properties

Array of CRMViewGroupBy

directionstring

fieldstringrequired

sourcestring

is_defaultboolean

is_pinnedboolean

metadataany

namestringrequired

row_heightstring

Allowed:compactcomfortablespacious

sortsCRMRecordSort[] | null

Show properties

Array of CRMRecordSort

directionstring

fieldstringrequired

sourcestring

source_list_idstring

visibilitystring

Allowed:privateshared

Responses

200OK

columnsCRMViewColumn[] | null

Show properties

Array of CRMViewColumn

fieldstringrequired

hiddenboolean

labelstring

pinnedstring

positioninteger<int32>

sourcestring

widthinteger<int32>

created_atstringrequired

descriptionstring | nullrequired

display_typestringrequired

filtersCRMRecordFilter[] | null

Show properties

Array of CRMRecordFilter

fieldstringrequired

operatorstring

sourcestring

valueany

group_byCRMViewGroupBy[] | null

Show properties

Array of CRMViewGroupBy

directionstring

fieldstringrequired

sourcestring

idstringrequired

is_defaultboolean

is_pinnedboolean

metadataanyrequired

namestringrequired

object_kindstringrequired

row_heightstring

sortsCRMRecordSort[] | null

Show properties

Array of CRMRecordSort

directionstring

fieldstringrequired

sourcestring

source_list_idstring | nullrequired

updated_atstringrequired

visibilitystring

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/crm/views/string" \
  -H "Content-Type: application/json" \
  -d '{
  "columns": [
    {
      "field": "string",
      "hidden": true,
      "label": "string",
      "pinned": "string",
      "position": 0,
      "source": "string",
      "width": 0
    }
  ],
  "description": "string",
  "display_type": "table",
  "filters": [
    {
      "field": "string",
      "operator": "string",
      "source": "string",
      "value": "string"
    }
  ],
  "group_by": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "is_default": true,
  "is_pinned": true,
  "metadata": "string",
  "name": "string",
  "row_height": "compact",
  "sorts": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "source_list_id": "string",
  "visibility": "private"
}'

const response = await fetch("/v1/crm/views/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "columns": [
    {
      "field": "string",
      "hidden": true,
      "label": "string",
      "pinned": "string",
      "position": 0,
      "source": "string",
      "width": 0
    }
  ],
  "description": "string",
  "display_type": "table",
  "filters": [
    {
      "field": "string",
      "operator": "string",
      "source": "string",
      "value": "string"
    }
  ],
  "group_by": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "is_default": true,
  "is_pinned": true,
  "metadata": "string",
  "name": "string",
  "row_height": "compact",
  "sorts": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "source_list_id": "string",
  "visibility": "private"
})
});

import requests

response = requests.patch(
    "/v1/crm/views/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "columns": [
    {
      "field": "string",
      "hidden": True,
      "label": "string",
      "pinned": "string",
      "position": 0,
      "source": "string",
      "width": 0
    }
  ],
  "description": "string",
  "display_type": "table",
  "filters": [
    {
      "field": "string",
      "operator": "string",
      "source": "string",
      "value": "string"
    }
  ],
  "group_by": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "is_default": True,
  "is_pinned": True,
  "metadata": "string",
  "name": "string",
  "row_height": "compact",
  "sorts": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "source_list_id": "string",
  "visibility": "private"
},
)

Response

{
  "columns": [
    {
      "field": "string",
      "hidden": true,
      "label": "string",
      "pinned": "string",
      "position": 0,
      "source": "string",
      "width": 0
    }
  ],
  "created_at": "string",
  "description": "string",
  "display_type": "string",
  "filters": [
    {
      "field": "string",
      "operator": "string",
      "source": "string",
      "value": "string"
    }
  ],
  "group_by": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "id": "string",
  "is_default": true,
  "is_pinned": true,
  "metadata": "string",
  "name": "string",
  "object_kind": "string",
  "row_height": "string",
  "sorts": [
    {
      "direction": "string",
      "field": "string",
      "source": "string"
    }
  ],
  "source_list_id": "string",
  "updated_at": "string",
  "visibility": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}