Upload and set a poster for a specified VideoPress video.
Resource Information
|
|
Method |
POST |
URL |
https://public-api.wordpress.com/rest/v1.1/videos/$guid/poster |
Requires authentication? |
No |
Method Parameters
Parameter |
Type |
Description |
$guid |
(string) |
The guid of the video |
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 |
at_time |
(int) |
Optional. |
is_millisec |
(bool) |
Optional. |
poster |
(media) |
An image to attach to the video. To upload media, the entire request should be multipart/form-data encoded. Accepts images (image/gif, image/jpeg, image/png) only at this time.
Example:
curl \ --form 'poster=@/path/to/file.jpg' \ -H 'Authorization: BEARER your-token' \ 'https://public-api.wordpress.com/rest/v1/videos/12345678/poster' |
poster_attachment_id |
(int) |
optional |
Response Parameters
Parameter |
Type |
Description |
poster |
(string) |
The url of the poster for the given videopress video |
Resource Errors
This endpoint does not return any errors.