POST /notifications/read

Mark a set of notifications as read.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/notifications/read
Requires authentication? No

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser Javascript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.

Request Parameters

Parameter Type Description
counts (array) Decrement the unread count for a notification. Key=note_ID, Value=decrement amount.

Response Parameters

Parameter Type Description
success (bool) Was the operation successful?
updated (array) IDs of any of the operated on notifications which have new, unread updates

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 bad_request Incorrect Parameters.
404 not_found Not a valid URL.
403 authorization_required An active access token must be used to retrieve notifications.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode '0=counts[1621046109] = 1' \
 ''
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
      1 => 'Content-Type: application/x-www-form-urlencoded',
    ),
    'content' => 
     http_build_query(  array (
        0 => 'counts[1621046109] = 1',
      )),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'',
	false,
	$context
);
$response = json_decode( $response );
?>