Pin or unpin a notification

PUT/api/v1/notifications/{notification_id}/pin

Toggle whether a notification is pinned to the top of the feed.

Operation ID: set_pinned_api_v1_notifications__notification_id__pin_put·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

notification_idstringrequired

Request body

Schema: SetPinnedRequest

pinnedbooleanrequired

Responses

200Successful Response

Schema: SuccessEnvelope_NotificationResponse_

successboolean
messagestring
codestring
dataNotificationResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

PUT/api/v1/notifications/{notification_id}/pin

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/notifications/{notification_id}/pin' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "pinned": false
}'