Mark notifications as seen

PUT/v1/api/store/{team_slug}/current_user_feed/seen

v1Operation ID v1_public_current_user_feed_seen

Marks the listed notifications as seen. They then drop out of the default list. Send a JSON array of {id} objects as the whole body.

Permission

Your own feed only.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

The body is an array of objects.

• idstringrequired

  A feed item id.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  An item has no id, or an id is not valid (validation_failed; error.fields names the field).

  Fix

  Send ids from the feed list.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  The list is empty, or the body is missing or {}: {"status": 500, "success": false, "error": {"code": "invalid_user", "message": "Current Auth User is not valid!"}}.

  Fix

  Send at least one item. The message is misleading: nothing is wrong with your key.

Notes

• Ids that are not yours are skipped without an error.
• Only your own feed changes; other people's feeds stay as they are.

Related

• PUTMark notifications as not seen/v1/api/store/{team_slug}/current_user_feed/unseen
• PUTMark all your notifications as seen/v1/api/store/{team_slug}/current_user_feed/mark_all_as_seen

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/current_user_feed/seen' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '[    {      "id": "H3w5wUZaIrCb52"    },    {      "id": "I2jYDEbcQRl0AW"    }  ]'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}