REST API

REST API

Legacy Poppulo platform REST API

Set Article Synopsis Image

Overview

NameDescription
HTTP MethodPUT
URLhttps://api.newsweaver.com/v2/{account code}/article/{article id}/synopsis_image
Query ParametersN/A
Request representationImage
Response representationStatus Entity
Success Response Code201 Created

Notes

We accept GIF, PNG and JPEG. Please use the correct Content-Type header to indicate the type of image. Large images will be scaled, extremely large images will be rejected.

Errors

  • 403 - Forbidden if API user doesn't have WRITE access to ARTICLES
  • 404 - Not Found if the article identifier does not exist
  • 409 - Conflict if the image is invalid or the type is not supported
  • Common errors (user/account authentication errors, API usage limit errors)