PinSavedView

PUT

/api/v1/t/{tenant}/saved-views/{savedViewId}/pin

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

Parameters

Path Parameters

tenant

required

string

Tenant slug

savedViewId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

pinned

required

boolean

Example^generated

{
  "pinned": true
}

Responses

200

OK

Media typeapplication/json

object

id

required

string format: uuid

name

required

string

filter

required

object

documentTypeId

required

null | string format: uuid

fileId

required

null | string format: uuid

tagIds

required

Array<string>

metadataConditions

required

Array<object>

object

fieldKey

required

string

operator

required

Allowed values: EqualTo NotEqualTo Contains GreaterThan GreaterThanOrEqual LessThan LessThanOrEqual IsEmpty IsNotEmpty

value

required

null | string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

pinned

required

boolean

Example

{
  "filter": {
    "metadataConditions": [
      {
        "operator": "EqualTo"
      }
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}