Update pinned company views

PUT

companies

views

pinned

curl --request PUT \
  --url 'https://api.claap.io/v1/companies/views/pinned?userEmail=jane.doe%40example.com' \
  --header 'Content-Type: application/json' \
  --header 'X-Claap-Key: <api-key>' \
  --data '{
  "viewIds": [
    "Default_Recent",
    "Vw5Rm1Xq8Ld4Tn2Hc6Jp9"
  ]
}'

{
  "result": [
    {
      "viewId": "Default_Recent",
      "name": "Recent",
      "visibility": "Public",
      "icon": ":clock1:",
      "isDefault": true,
      "ownerId": "#global",
      "columns": [
        {
          "type": "Default",
          "columnId": "Name",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "Domain",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "LastInteraction",
          "isHidden": false
        }
      ],
      "filters": {},
      "sort": [
        {
          "field": "LastInteraction",
          "order": "Desc"
        }
      ]
    },
    {
      "viewId": "Vw5Rm1Xq8Ld4Tn2Hc6Jp9",
      "name": "Target accounts",
      "visibility": "Public",
      "icon": ":dart:",
      "isDefault": false,
      "ownerId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
      "columns": [
        {
          "type": "Default",
          "columnId": "Name",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "Domain",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "Deals",
          "isHidden": false
        }
      ],
      "filters": {
        "dealStatusIn": [
          "Open"
        ],
        "hasInteraction": true
      },
      "sort": [
        {
          "field": "Name",
          "order": "Asc"
        }
      ]
    }
  ]
}

Replaces the company views a user has pinned to the tab bar of the companies table. Send the full ordered list: a single call pins, unpins and reorders views. viewIds must contain at least one view. A user can pin public views, the private views they can access and built-in default views. The update fails, and nothing changes, if viewIds contains duplicates or a view the user cannot access.

curl --request PUT \
  --url 'https://api.claap.io/v1/companies/views/pinned?userEmail=jane.doe%40example.com' \
  --header 'Content-Type: application/json' \
  --header 'X-Claap-Key: <api-key>' \
  --data '{
  "viewIds": [
    "Default_Recent",
    "Vw5Rm1Xq8Ld4Tn2Hc6Jp9"
  ]
}'

Authorizations

X-Claap-Key

string

header

required

Query Parameters

userEmail

string<email>

required

Email address of the user whose pinned views are updated. It must belong to an active workspace member.

Example:

"jane.doe@example.com"

Body

application/json

viewIds

string[]

required

Identifiers of the views to pin, in tab bar order. Replaces the current pinned views. Must contain at least one view; each view must be accessible to the user, and must appear only once.

Minimum array length: 1

Response

Pinned company views were successfully updated

result

object[]

required

Show child attributes

curl --request PUT \
  --url 'https://api.claap.io/v1/companies/views/pinned?userEmail=jane.doe%40example.com' \
  --header 'Content-Type: application/json' \
  --header 'X-Claap-Key: <api-key>' \
  --data '{
  "viewIds": [
    "Default_Recent",
    "Vw5Rm1Xq8Ld4Tn2Hc6Jp9"
  ]
}'

{
  "result": [
    {
      "viewId": "Default_Recent",
      "name": "Recent",
      "visibility": "Public",
      "icon": ":clock1:",
      "isDefault": true,
      "ownerId": "#global",
      "columns": [
        {
          "type": "Default",
          "columnId": "Name",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "Domain",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "LastInteraction",
          "isHidden": false
        }
      ],
      "filters": {},
      "sort": [
        {
          "field": "LastInteraction",
          "order": "Desc"
        }
      ]
    },
    {
      "viewId": "Vw5Rm1Xq8Ld4Tn2Hc6Jp9",
      "name": "Target accounts",
      "visibility": "Public",
      "icon": ":dart:",
      "isDefault": false,
      "ownerId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
      "columns": [
        {
          "type": "Default",
          "columnId": "Name",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "Domain",
          "isHidden": false
        },
        {
          "type": "Default",
          "columnId": "Deals",
          "isHidden": false
        }
      ],
      "filters": {
        "dealStatusIn": [
          "Open"
        ],
        "hasInteraction": true
      },
      "sort": [
        {
          "field": "Name",
          "order": "Asc"
        }
      ]
    }
  ]
}

API documentation

Recording

Deal

Company

Contact

Folder

Admin automation

Workspace

User

Invite

User group

Webhook

Update pinned company views

Authorizations

Query Parameters

Body

Response