/api/v1/saved-views/prefs/{surface}

PUT

/api/v1/saved-views/prefs/{surface}

curl --request PUT \
  --url https://example.com/api/v1/saved-views/prefs/search \
  --header 'Content-Type: application/json' \
  --data '{ "defaultViewId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "pinned": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Parameters

Path Parameters

surface

required

string

Allowed values: search activity trash things contents inbox schedules lending paperwork expiring notifications incidents ai-calls services vehicles fuel readings condition-reports moves move-boxes

Request Body^required

Media typeapplication/json

object

defaultViewId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

pinned

required

Array<string>

<= 20 items

Example^generated

{
  "defaultViewId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "pinned": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

200

Default Response

Media typeapplication/json

object

defaultViewId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

pinned

required

Array<string>

Example^generated

{
  "defaultViewId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "pinned": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}