Articles

Create an article from HTML

The direct route, when you already have the text. The markup goes through the same sanitiser as imports: scripts, inline styles and elements that do not belong in an article are removed, and what was removed appears in the response.

Optimisation fields are normalised, not rejected: five comma-separated keywords keep the first; ten tags keep the first three. An article supports one term, and twenty tags mean archive pages with a single text on them.

Required scope: ARTICLES_WRITE.

post/partner/articles

Request

  • Base URL: https://app.comunicate.eu/api/v1
  • URL: https://app.comunicate.eu/api/v1/partner/articles
  • 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)

Request body

titlestring required

The article title.

contentHtmlstring required

The article body, as HTML.

focusKeywordstring

The keyword to optimise for. One only — from a list, the first is kept.

tagsstring[]

At most three, however many are sent. A comma-separated list inside one element is also accepted.

metaDescriptionstring

The description shown in search results.

slugstring

The proposed article URL slug. WordPress may change it on collision; what actually resulted is read back and kept on the publication.

excerptstring

The summary themes use in listings and on category pages.

featuredImageAltstring

The featured image's alt text. Its absence is one of the findings the SEO analysis reports.

seoTitlestring

The search-result title, when it differs from the article title.

featuredImageUrlstring

The featured image. Can be the URL returned by POST /partner/media.

campaignIdstring uuid

The campaign the article belongs to.

idempotencyKeystring

Chosen by you — a locally generated UUID is enough. Sent again, for the same organisation, it returns the article already created instead of making a new one. No effect on PATCH. Recommended for any code that might resend the request after a timeout.

Response

OK

object required

Changes

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