Toggle pin status of a note

PATCH /players/{playerId}/notes/{noteId}/pin

Toggle pin status of a note

cURL

curl --request PATCH \
  --url https://mock-api.cevro.ai/v1/players/{playerId}/notes/{noteId}/pin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Session-ID: <x-session-id>' \
  --data '{
  "pinned": true
}'

200

{
  "success": true,
  "pinned": true,
  "message": "<string>"
}

Authorizations

bearerAuthsessionAuth

Authorization · string · header · required

API Bearer token. For this demo, any non-empty string is accepted.

Headers

X-Session-ID · string · required

Path Parameters

playerId · string · required

noteId · string · required

Body

application/json

pinned · boolean · required

Example:

true

Response

200

application/json

Note pin status updated

success · boolean

pinned · boolean

message · string