Articles

Import a document

Accepts Word documents (.docx, .docm, .doc, .dot, .dotx), LibreOffice and OpenOffice ones (.odt, .ott, .fodt, .sxw), .rtf, .wpd, .wps, plus .html and .htm. Anything other than .docx goes through LibreOffice, so they take a few seconds longer.

File order matters: the first file is the document, the second — optional — is the featured image. They cannot be told apart by field name, because everyone names their files differently.

Images inside the document are pulled into the media library and rewritten in the text; those that could not be pulled appear in images.skipReasons with the reason. Metadata — description, tags — is filled in afterwards, in the background.

Required scope: ARTICLES_WRITE.

post/partner/articles/import

Request

  • Base URL: https://app.comunicate.eu/api/v1
  • URL: https://app.comunicate.eu/api/v1/partner/articles/import
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.comunicate.eu/api/v1/oauth/authorize, token URL https://app.comunicate.eu/api/v1/oauth/token, scopes: ARTICLES_WRITE)

Response

OK

articles[]string

The articles created, with title and word count.

imagesobject

How many images were imported, reused, converted, and why the rest were skipped.

sanitizedobject

What the sanitiser removed. If the article looks different from the document, this says why.

Changes

No recorded changes to this operation across all 1 revision of this API.