Skip to main content

In your app

A controller answers a route on your app: it calls createAuthor() and returns the answer.

Add the controller

app/controllers/create_author_controller.ts
The other values are the example’s: take yours from the request, a form or your database.

Add the route

start/routes.ts
Put it behind your auth middleware (.use(middleware.auth())): it acts with your key’s access.

Call it

Your own page’s form or script sends POST /author and gets back its answer as JSON. Test it, below, calls it.

Required parameters

One object, e.g. createAuthor({ title }); leave out the optional fields.
string
required
Required. Its title: the name it goes by in every list, and the heading of its page where it has one.
AposMode | null | undefined
Optional. Leave it out and the site uses "published". published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403. One of draft, published.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. en (default: the site’s default locale).
string | null | undefined
Optional. Leave it out and the site uses "". Optional one or two sentences about this author.
readonly Readonly<Record<string, unknown>>[] | null | undefined
Optional. The FetchskiCMS login account this author profile belongs to (used to source the photo, and by SSO to sync it). Leave empty for guest contributors. The related @apostrophecms/user documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.
boolean | null | undefined
Optional. Leave it out and the site uses true. Master switch for this author’s public byline. Turn off to hide the name AND photo on every post that credits this author.
boolean | null | undefined
Optional. Leave it out and the site uses true. When on, the linked login account’s profile photo appears next to this author. Has no effect without a login account, or when “Show author on the site” is off.
string | null | undefined
Optional. Leave it out and the site uses "". The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). Left out, it’s made from the title.
Visibility | null | undefined
Optional. Leave it out and the site uses "public". Select whether this content is public or private. One of public, loginRequired.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
boolean | null | undefined
Optional. Leave it out and the site uses false. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.
An Author. Author content type. Read its properties (author.title): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _user → user).
string
Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.
string
Always sent. The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.
string
Always sent. The document type’s name: always this type’s.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Optional one or two sentences about this author.
readonly Readonly<Record<string, unknown>>[] | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The FetchskiCMS login account this author profile belongs to (used to source the photo, and by SSO to sync it). Leave empty for guest contributors. The related @apostrophecms/user documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.
boolean | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Master switch for this author’s public byline. Turn off to hide the name AND photo on every post that credits this author.
boolean | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When on, the linked login account’s profile photo appears next to this author. Has no effect without a login account, or when “Show author on the site” is off.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
Visibility | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
boolean | null
Sometimes sent: undefined when the site leaves it out, and it can be null. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it was created (ISO 8601). Format: an ISO 8601 date and time.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.
400
The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.
401
The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage, errorName, data.
403
The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.
404
Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.
500
The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage, errorName, data.
no answer
No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. Read: reason, neverConnected.
not sent
The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).
any other
Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.
setup
sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.
setup
The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with content:authors:write (or a master above it: content:authors:all, content:all, admin:all). In published mode (the default) it goes live too, so the key also needs content:authors:publish (or a master above it); send aposMode=draft to change only the draft. A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
  • Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
  • Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
  • Timeout: 15 s per attempt by default; raise timeout (milliseconds) in config/attract.ts for longer.

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/authors_create_author.spec.ts, then run your tests:
tests/unit/authors_create_author.spec.ts
Terminal
Answer with your own values: fake authors.createAuthor with factories.Author({...}), the fields you give over a valid example.
tests/unit/authors_create_author_answers.spec.ts

List an author’s locales

site.authors().getAuthorLocales()

List authors

site.authors().listAuthors()

Get an author

site.authors().getAuthor()

Replace an author

site.authors().replaceAuthor()

Delete an author

site.authors().deleteAuthor()

Update an author

site.authors().updateAuthor()

POST /author

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.