POST /read/email-settings/

Returns the email settings

Resource Information

Method POST
Requires authentication? No

Query Parameters

Parameter Type Description
context (string)
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
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)
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
mail_option (string) The mail format: html or text
delivery_day (int) The index of the day of the week to send the email: 0 = Sunday, 1 = Monday, etc.
delivery_hour (int) The index of the hour of the day to send the email: 0 = 12am, 1 = 1am, etc.
blocked (bool) If this user has blocked emails
frequency (string) The default email frequency for this user

Response Parameters

Parameter Type Description
settings (array) The updated settings

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 invalid_input The frequency value provided is invalid.
400 invalid_input The blocked value provided is invalid.
403 authorization_required Authorization is required.
400 invalid_input The delivery_hour value provided is invalid.
400 invalid_input The delivery_day value provided is invalid.
400 invalid_input The mail_option value provided is invalid.


curl ''
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',

$context  = stream_context_create( $options );
$response = file_get_contents(
$response = json_decode( $response );


    "settings": {
        "errors": {
            "authorization_required": [
                "Authorization is required."
        "error_data": {
            "authorization_required": 403