Create an article

Create an article. An article is a versioned piece of content — for example a note or an FAQ entry — of a given article type (type_id), and it must be linked to at least one LOCATION, SERVICE, or STAFF entity (see links and the Article Types API, which documents how a type's supported link patterns and content shape are configured).

For article types whose link pattern has SINGLE cardinality for an entity type, that entity may be linked by at most one live article of this article type at a time; creating a second one fails with 409 Conflict. This endpoint always creates a brand-new article — to add or update content in bulk (for example from an ingestion pipeline), use POST /locations-directory/articles/bulk instead, which recognizes a re-submitted link tuple as an update rather than a duplicate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

locations-directory:write

Body Params

The article to create.

An article is a versioned piece of content — for example a note or an FAQ entry — of a given article type (type_id), linked to one or more LOCATION, SERVICE, or STAFF entities. links must be present with at least one of locations/services/staff non-empty — see #/article_links.

string
required
length between 1 and 64

Id of the article type this article belongs to (see the Article Types API). The type determines the expected content format (free text or a JSON value validated against a JSON Schema) and which combinations of linked entities (links) are allowed.

string
required

The article's content. Its shape depends on the article type's configured content type: a JSON string for TEXT types, or an arbitrary JSON value validated against the type's JSON Schema for JSON types. Serializes to at most 100,000 characters.

tags
array of strings
Defaults to []

Free-form labels for the article, useful for filtering with GET /locations-directory/articles. Up to 50 tags, each up to 64 characters and non-blank.

tags
links
object
required
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json