Saved Pins

Generated saved pins operations.

PUT/v1/saved-pins/{kind}/{id}Save saved pinsplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: put_saved_pins_kind_id
Max body: 64 KiB

Parameters

Name	In	Type
`kind`required	path	`string`
`id`required	path	`string`
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "expectedRevision": 0,
  "operationId": "id_8h2k4q",
  "pinned": true
}

Schema

expectedRevisionintegerrequired
operationIdstringrequired
pinnedbooleanrequired

Responses

200Successapplication/json

Example

{
  "deleted": true,
  "operationId": "id_8h2k4q",
  "pinRevision": 0,
  "pinned": true,
  "playlistId": "id_8h2k4q",
  "resourceId": "id_8h2k4q",
  "revision": 0,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

deletedbooleanrequired
operationIdstringrequired
pinRevisionintegerrequired
pinnedbooleanrequired
playlistIdstringrequired
resourceIdstringrequired
revisionintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundrevision_mismatchinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/saved-pins/{kind}/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"operationId":"id_8h2k4q","pinned":true}'

GET/v1/saved-pins/orderRead saved pins orderread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_saved_pins_order

Responses

200Successapplication/json

Example

{
  "order": [
    {
      "id": "id_8h2k4q",
      "kind": "string",
      "name": "Fargo",
      "pinRevision": 0
    }
  ],
  "revision": 0,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

orderarray of objectrequired
- idstringrequired
- kindstringrequired
- namestringrequired
- pinRevisionintegerrequired
revisionintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/saved-pins/order" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/saved-pins/orderSave saved pins orderplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: put_saved_pins_order
Max body: 64 KiB

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "expectedRevision": 0,
  "order": [
    {
      "id": "id_8h2k4q",
      "kind": "string"
    }
  ]
}

Schema

expectedRevisionintegerrequired
orderarray of objectrequired
- idstringrequired
- kindstringrequired

Responses

200Successapplication/json

Example

{
  "order": [
    {
      "id": "id_8h2k4q",
      "kind": "string"
    }
  ],
  "revision": 0,
  "serverId": "id_8h2k4q",
  "viewerFence": "string"
}

Schema

orderarray of objectrequired
- idstringrequired
- kindstringrequired
revisionintegerrequired
serverIdstringrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/saved-pins/order" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"order":[{"id":"id_8h2k4q","kind":"string"}]}'