Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Saved Views

updateSavedView

Updates a saved view

put/v1/entity/view/{id}

Path parameters

idstring uuid required

Generated uuid for a saved view

View id

Request body

idstring uuid

Generated uuid for a saved view

created_atstring
updated_atstring
slugEntitySlug[] required

list of schemas a view can belong to

namestring required

User-friendly identifier for the saved view

orgstring

Organisation ID a view belongs to

sharedboolean

boolean property for if a view is shared with organisation

isFavoritedBystring[]

List of users (IDs) that have favorited the view

ui_configobject required
shared_withstring[]

List of users ('${userId}'), user groups ('group_${groupId}'), or partner users ('${partnerOrgId}_${partnerUserId}') that the view is shared with

Example request

{
  "slug": [
    "contact"
  ],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": [
    "11701"
  ],
  "created_by": {
    "user_id": "10598",
    "org_id": "739224"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": [
    "112233"
  ]
}

Response

Success

idstring uuid

Generated uuid for a saved view

created_atstring
updated_atstring
slugEntitySlug[] required

list of schemas a view can belong to

namestring required

User-friendly identifier for the saved view

orgstring

Organisation ID a view belongs to

sharedboolean

boolean property for if a view is shared with organisation

isFavoritedBystring[]

List of users (IDs) that have favorited the view

ui_configobject required
shared_withstring[]

List of users ('${userId}'), user groups ('group_${groupId}'), or partner users ('${partnerOrgId}_${partnerUserId}') that the view is shared with

Example response

{
  "slug": [
    "contact"
  ],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": [
    "11701"
  ],
  "created_by": {
    "user_id": "10598",
    "org_id": "739224"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": [
    "112233"
  ]
}