Update a testimonial

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const testimonial = await site.testimonials().updateTestimonial({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "quote": "Example quote",
  "authorName": "Example author name",
  "authorTitle": "Example author title",
  "rating": 5,
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "testimonialFontOverrides": [],
  "_authorPhoto": [
    {}
  ],
  "authorPhotoUrl": "https://acme.example/example",
  "link": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const testimonial = await site.testimonials().updateTestimonial({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "quote": "Example quote",
  "authorName": "Example author name",
  "authorTitle": "Example author title",
  "rating": 5,
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "testimonialFontOverrides": [],
  "_authorPhoto": [
    {}
  ],
  "authorPhotoUrl": "https://acme.example/example",
  "link": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/update-testimonial.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function updateTestimonial(site: SiteClient, id: string) {
  return site.testimonials().updateTestimonial({ id });
}

Call it

A script makes the client once and calls the function:

scripts/update-testimonial.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { updateTestimonial } from '../src/attract/update-testimonial.ts';

const site = createSiteClient();
console.log(await updateTestimonial(site, 'clx8m2k4p0000a1b2c3d4e5f6'));

Terminal

node --env-file=.env scripts/update-testimonial.ts

A route handler, a job or a queue worker calls it the same way.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

TypeScript

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const row = (await site.testimonials().listTestimonialsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started'); // { id, title, slug }, or undefined

Pass row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).

Required parameters

One object, e.g. updateTestimonial({ id }); leave out the optional fields.

string

required

Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Optional parameters

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 "". Its title: the name it goes by in every list, and the heading of its page where it has one.

string | null | undefined

Optional. Leave it out and the site uses "". The testimonial itself, in the author’s words.

string | null | undefined

Optional. Leave it out and the site uses "". Who said it — e.g. “Jordan Lee”.

string | null | undefined

Optional. Leave it out and the site uses "". An optional second line under the name — e.g. “Founder, Acme Co.” or “Customer since 2021”.

number | null | undefined

Optional. Leave it out and the site uses 5. Optional. Only shown when the Testimonials section has “Show star rating” turned on. 1 to 5.

boolean | null | undefined

Optional. Leave it out and the site uses false. Hand-curation flag. The widget can be set to show only featured testimonials.

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).

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.

readonly TestimonialTestimonialFontOverridesItem[] | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Set part of this testimonial’s card in a different typeface. Leave empty to follow the section (and the site fonts). At most 4 items.

Show TestimonialTestimonialFontOverridesItem

string

The row’s id, unique in its array.

Target | null

Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of all, heading, body, eyebrow, button, code.

Source | null

Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of slot, curated, cdn, upload.

Slot | null

Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of display, body, accent.

Curated | null

Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of archivo, bricolage-grotesque, clash-display, courier-prime, dm-mono, dm-sans, fira-code, fraunces, general-sans, ibm-plex-mono, ibm-plex-sans, inconsolata, inter, jetbrains-mono, karla, lora, manrope, nunito-sans, outfit, playfair-display, public-sans, red-hat-mono, satoshi, sentient, sora, source-code-pro, source-sans-3, source-serif-4, space-grotesk, space-mono, spline-sans-mono, supreme, switzer, syne, ubuntu-mono, unbounded, victor-mono, work-sans, zodiak.

CdnProvider | null

Where to browse for the family. Pick one, then follow the link below to find the exact name. One of bunny, fontshare.

string

Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”. A name the provider doesn’t have loads nothing and this row is ignored.

string

Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

readonly TestimonialTestimonialFontOverridesItemUploadsItem[]

A list of TestimonialTestimonialFontOverridesItemUploadsItem. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

Show TestimonialTestimonialFontOverridesItemUploadsItem

Readonly<Record<string, unknown>>

required

Required. File attachment reference.

string

The row’s id, unique in its array.

Weight | null

Weight. One of 100, 200, 300, 400, 500, 600, 700, 800, 900.

Style | null

Style. One of normal, italic.

Readonly<Record<string, unknown>>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

Fallback | null

Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of sans, serif, mono.

Readonly<Record<string, unknown>>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

readonly Readonly<Record<string, unknown>>[] | null | undefined

Optional. Optional. A first-party headshot from the media library. Falls back to a lettered-initial avatar when empty. The related @apostrophecms/image 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.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Alternative to uploading: a full https:// link to a photo hosted elsewhere. Only used when no Author photo is selected above — prefer uploading when you can (it enables focal point and responsive sizes). When set, a URL; empty or null when not.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. A link to the full story / case study / original post. When set, a URL; empty or null when not.

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.

Returns

A Testimonial. Testimonial content type. Read its properties (testimonial.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, _authorPhoto → authorPhoto).

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 testimonial itself, in the author’s words.

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

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. Who said it — e.g. “Jordan Lee”.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. An optional second line under the name — e.g. “Founder, Acme Co.” or “Customer since 2021”.

number | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Optional. Only shown when the Testimonials section has “Show star rating” turned on. 1 to 5.

boolean | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Hand-curation flag. The widget can be set to show only featured testimonials.

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.

readonly TestimonialTestimonialFontOverridesItem[] | null

Sometimes sent: undefined when the site leaves it out, and it can be null. A list of TestimonialTestimonialFontOverridesItem. Optional. Set part of this testimonial’s card in a different typeface. Leave empty to follow the section (and the site fonts). At most 4 items.

Show TestimonialTestimonialFontOverridesItem

string

Sometimes sent: undefined when the site leaves it out. The row’s id, unique in its array.

Target | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of all, heading, body, eyebrow, button, code; a newer site may send others, so keep a fallback.

Source | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of slot, curated, cdn, upload; a newer site may send others, so keep a fallback.

Slot | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of display, body, accent; a newer site may send others, so keep a fallback.

Curated | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of archivo, bricolage-grotesque, clash-display, courier-prime, dm-mono, dm-sans, fira-code, fraunces, general-sans, ibm-plex-mono, ibm-plex-sans, inconsolata, inter, jetbrains-mono, karla, lora, manrope, nunito-sans, outfit, playfair-display, public-sans, red-hat-mono, satoshi, sentient, sora, source-code-pro, source-sans-3, source-serif-4, space-grotesk, space-mono, spline-sans-mono, supreme, switzer, syne, ubuntu-mono, unbounded, victor-mono, work-sans, zodiak; a newer site may send others, so keep a fallback.

CdnProvider | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of bunny, fontshare; a newer site may send others, so keep a fallback.

string

Sometimes sent: undefined when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”. A name the provider doesn’t have loads nothing and this row is ignored.

string

Sometimes sent: undefined when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

readonly TestimonialTestimonialFontOverridesItemUploadsItem[]

Sometimes sent: undefined when the site leaves it out. A list of TestimonialTestimonialFontOverridesItemUploadsItem. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

Show TestimonialTestimonialFontOverridesItemUploadsItem

Readonly<Record<string, unknown>>

Always sent. File attachment reference.

string

Sometimes sent: undefined when the site leaves it out. The row’s id, unique in its array.

Weight | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Weight. One of 100, 200, 300, 400, 500, 600, 700, 800, 900; a newer site may send others, so keep a fallback.

Style | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Style. One of normal, italic; a newer site may send others, so keep a fallback.

Readonly<Record<string, unknown>>

Always there: {} when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

Fallback | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of sans, serif, mono; a newer site may send others, so keep a fallback.

Readonly<Record<string, unknown>>

readonly Readonly<Record<string, unknown>>[] | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Optional. A first-party headshot from the media library. Falls back to a lettered-initial avatar when empty. The related @apostrophecms/image 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.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Alternative to uploading: a full https:// link to a photo hosted elsewhere. Only used when no Author photo is selected above — prefer uploading when you can (it enables focal point and responsive sizes). When set, a URL; empty or null when not.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Optional. A link to the full story / case study / original post. When set, a URL; empty or null when not.

FaqCategorySource | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Set automatically. Demo placeholders are removed the moment a real testimonial is published. One of manual, demo; 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. Internal de-duplication key set by the demo seed.

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.

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.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).

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 your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

setup

The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Access: an API key with content:testimonials:write (or a master above it: content:testimonials:all, content:all, admin:all). In published mode (the default) it goes live too, so the key also needs content:testimonials:publish (or a master above it); send aposMode=draft (or a draft _id and no aposMode) 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) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.

tests/testimonials-updateTestimonial.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { updateTestimonial } from '../src/attract/update-testimonial.ts';

test('testimonials.updateTestimonial', async () => {
  const site = fakeSite();
  await updateTestimonial(site, 'clx8m2k4p0000a1b2c3d4e5f6');
  site.assertCalled('testimonials.updateTestimonial', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6');
});

Answer with your own values: fake testimonials.updateTestimonial with factories.Testimonial({...}), the fields you give over a valid example.

tests/testimonials-updateTestimonial-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('testimonials.updateTestimonial answers your values', async () => {
  const site = fakeSite({
    'testimonials.updateTestimonial': factories.Testimonial({ title: 'Your value' })
  });
  const testimonial = await site.testimonials().updateTestimonial({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
  assert.equal(testimonial.title, 'Your value');
});

List a testimonial’s locales

site.testimonials().getTestimonialLocales()

List testimonials

site.testimonials().listTestimonials()

Create a testimonial

site.testimonials().createTestimonial()

Get a testimonial

site.testimonials().getTestimonial()

Replace a testimonial

site.testimonials().replaceTestimonial()

Delete a testimonial

site.testimonials().deleteTestimonial()

PATCH /testimonial/{_id}

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

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const testimonial = await site.testimonials().updateTestimonial({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "quote": "Example quote",
  "authorName": "Example author name",
  "authorTitle": "Example author title",
  "rating": 5,
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "testimonialFontOverrides": [],
  "_authorPhoto": [
    {}
  ],
  "authorPhotoUrl": "https://acme.example/example",
  "link": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Find the id

Behavior

Test it

List a testimonial’s locales

List testimonials

Create a testimonial

Get a testimonial

Replace a testimonial

Delete a testimonial

PATCH /testimonial/{_id}

In your app

Find the id

Behavior

Test it

Related

List a testimonial’s locales

List testimonials

Create a testimonial

Get a testimonial

Replace a testimonial

Delete a testimonial

PATCH /testimonial/{_id}