Returns the email settings
Resource Information
|
|
Method |
POST |
URL |
https://public-api.wordpress.com/rest/v1.1/read/email-settings/ |
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 |
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 WP.com emails |
frequency |
(string) |
The default email frequency for this user |
Response Parameters
Parameter |
Type |
Description |
settings |
(array) |
The updated settings |
Resource Errors
This endpoint does not return any errors.