> ## Documentation Index > Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt > Use this file to discover all available pages before exploring further. # Replace a cookie > Replaces the whole document: every field left out is reset to its default. PATCH changes only the fields sent. Update an existing cookie. **Access:** an API key with `global:write` (or a master above it: `global:all`, `admin:all`). In published mode (the default) it goes live too, so the key also needs `global: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`. ## OpenAPI ````yaml /api-reference/openapi.yaml put /cookie/{_id} openapi: 3.1.0 info: title: Fetchski Attract CMS API description: >- Auto-generated OpenAPI spec for this Fetchski site instance. Authenticate machine-to-machine requests with an API key by sending the header `Authorization: ApiKey `. Keys are issued in the CMS (API Keys) and carry scopes that limit them to specific actions. Each key also has its own security policy, chosen when it is created: a signing mode (token only, signed writes, or every request signed with the key’s signing secret via `X-Fetchski-Timestamp` + `X-Fetchski-Signature`), an optional network allowlist, and reads/writes-per-minute limits (429 with `Retry-After` over them). Some routes require a signature from every key — see each route. version: 1.0.0 servers: - url: https://{host}/api/v1 description: 'Your site: set `host` to its host name.' variables: host: default: acme.example security: [] tags: - name: Authentication description: >- Sign in as a person to get a bearer token or a session cookie. Integrations use an API key instead: send `Authorization: ApiKey `. - name: SDK Packages description: >- The site’s own npm registry and Composer repository for the Attract SDKs, so an app installs them with one of the site’s API keys. Point npm, pnpm, Bun or Composer at them; the SDKs never call them. - name: Pages description: 'The page tree: each page’s content, place and URL.' - name: Global Content description: Site-wide content and settings every page shares. - name: Redirects description: Old URLs and where they now send visitors. - name: Internationalization description: The site’s locales. - name: Languages description: >- The site’s languages: the main language’s name and every further language’s name, code and Public switch. A save applies at once: a new language gets its home page and its own addresses (/fr/…), and its pages are then translated with each type’s localize routes. - name: Page Templates description: >- The site’s whole-page starting arrangements. They are not pages of the site (the Pages list leaves them out for API keys): read one, then make a page from it with Pages → create and `_copyingId` (`copyingId` in the SDKs). - name: Blog Posts description: The blog’s posts, and importing them from Markdown or MDX. - name: Blog Categories description: The categories posts are filed under. - name: Authors description: The people posts are credited to. - name: Team Members description: The people the Team section shows. - name: Testimonials description: Quotes from customers. - name: FAQ Items description: Questions and their answers. - name: FAQ Categories description: The groups questions are sorted into. - name: Google Reviews description: Reviews from the business’s Google profile, synced on a schedule. - name: Instagram Posts description: Posts from the connected Instagram account, synced on a schedule. - name: Service Areas description: The places the business serves, for the service map. - name: Cookies description: The cookies the consent banner declares. - name: Media description: The Images and Files libraries, and their tags. - name: Videos description: The Videos library. - name: Image Folders description: The folders that organize the Images library. - name: File Folders description: The folders that organize the Files library. - name: Video Folders description: The folders that organize the Videos library. - name: Photo Albums description: Hand-picked, ordered sets of photos for galleries. - name: Photo Feeds description: >- Feeds that collect photos from a connected photo source into the Images library on a schedule. - name: Attachments description: Uploading files and cropping images. - name: Fetchski Media description: >- Read-only discovery over the Images and Videos libraries: find what to reference in an MDX blog import, or which file to use, with its URLs. - name: Forms description: The site’s forms and their fields. - name: Form Submissions description: >- What visitors sent through the site’s forms. Submissions hold personal details: give a key `forms:read` only where it is needed. - name: Conversion Events description: >- The conversion event log — one record per conversion, with its attribution and consent snapshot and its delivery to each ad platform. Read it incrementally, post facts from other systems (a reservation purchase, a lead outcome), and adjust them (refunds, cancellations). One event ID travels everywhere as the platforms’ de-duplication key. - name: Visitor Attribution description: >- Per-visitor attribution on this site: first touch, last ad or campaign touch, and the ad platforms’ browser IDs. The join other systems use to attach a purchase to the marketing-site journey that led to it. - name: Ads Metrics description: >- Aggregates for dashboards: ad-click landings and conversions, by day, platform, campaign and more. - name: Conversions description: >- Conversion definitions — the visitor actions (a lead, a call click, a booking, a purchase) this site reports to the ad platforms, each with a row per platform. Managed by administrators in the CMS. - name: Webhooks description: >- Push notifications of form submissions and conversion-event changes to the site’s Webhook Destinations — signed with each destination’s own secret, retried for a day, at-least-once. Set destinations up in the CMS (Webhook Destinations, for people granted “Manage webhook destinations”): URL, events, optional filters and custom headers, and the signing secret shown once. - name: Request Log description: >- The page views the site captured (Connections → Tracking → Request log), and the query parameters on them: campaign tags and ad click IDs. paths: /cookie/{_id}: put: tags: - Cookies summary: Replace a cookie description: >- Replaces the whole document: every field left out is reset to its default. PATCH changes only the fields sent. Update an existing cookie. **Access:** an API key with `global:write` (or a master above it: `global:all`, `admin:all`). In published mode (the default) it goes live too, so the key also needs `global: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`. operationId: replaceCookie parameters: - name: _id in: path required: true schema: type: string description: >- 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`). - $ref: '#/components/parameters/AposMode' - $ref: '#/components/parameters/AposLocale' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Cookie' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Cookie' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - ApiKeyAuth: - global:write - BearerAuth: [] x-codeSamples: - lang: typescript label: TypeScript source: >- import { createSiteClient } from '@fetchski/attract-cms-sdk'; const site = createSiteClient(); const cookie = await site.cookies().replaceCookie({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', provider: 'This website', category: 'necessary', purpose: 'Example purpose' }); - lang: php label: Laravel source: >- use Fetchski\AttractCmsLaravel\Facades\Attract; $cookie = Attract::cookies()->replaceCookie(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', provider: 'This website', category: 'necessary', purpose: 'Example purpose'); components: parameters: AposMode: name: aposMode in: query description: >- `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content::write`), or a signed-in editor. The public and a key with only the read scope get 403. required: false schema: type: string enum: - draft - published default: published example: published AposLocale: name: aposLocale in: query description: >- The locale to read or write, e.g. `en` (default: the site’s default locale). required: false schema: type: string example: fr schemas: Cookie: type: object properties: title: type: string title: Name description: >- What a visitor would see in their browser — the cookie’s exact name (fetchski_vid), or the tool’s name where it isn’t a cookie (Google Maps). default: '' provider: type: string title: Provider description: >- Who receives the data. Name the legal entity for a third party (e.g. “Google LLC”) — a reader is entitled to know who that is. default: This website category: type: string title: Category description: >- Which consent switch controls this. “Strictly necessary” cannot be declined, so only put something here if the site genuinely cannot work without it. default: necessary enum: - necessary - functional - analytics - marketing purpose: type: string title: Purpose (one line) description: >- The one-sentence summary shown in the policy table and the banner’s details list. Say what it does for the visitor, not how it works. default: '' sortOrder: type: - integer - 'null' title: Sort order description: >- Order WITHIN its category, lowest first. Categories themselves always appear in consent order. default: 50 slug: type: string description: >- The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). title: Slug default: '' x-fetchski-write-optional: Left out, it’s made from the title. visibility: type: - string - 'null' title: Visibility default: public enum: - public - loginRequired - null description: >- Who may see it on the site: `public` (everyone) or `loginRequired` (signed-in people only). storageType: type: - string - 'null' title: Type description: >- Not everything in a cookie policy is a cookie — an embedded map or a hot-linked image stores nothing but still sends data to someone else. default: cookie enum: - cookie - localStorage - sessionStorage - script - embed - pixel - null firstParty: type: - boolean - 'null' title: First-party description: >- On when this site sets and reads it itself. Off when it belongs to another company. default: true domain: type: - string - 'null' title: Domain description: >- Optional. The domain it is set on or sent to (e.g. google.com), where that differs from this site. default: '' duration: type: - string - 'null' title: Duration description: >- How long it lasts, in plain words — “Session”, “6 months”, “1 year”, or “No cookie set”. default: Session privacyPolicyUrl: type: - string - 'null' title: Provider’s privacy policy description: >- Optional but expected for a third party — the policy page links to it. When set, a URL; empty or null when not. disclosure: title: Disclosure description: >- The fuller explanation shown under this entry on the Cookie Policy page. Plain language, no legalese — what is collected, why, and what declining costs the visitor. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. allOf: - $ref: '#/components/schemas/RichTextMax1Area' builtInKey: type: - string - 'null' title: Built-in key description: >- Set for entries that ship with Fetchski CMS. Blank means this site added it. default: '' readOnly: true embedScriptId: type: - string - 'null' title: Declared by Embed Script description: >- Set for entries added by an Embed Script. They appear on the Cookie Policy only while that script is enabled. default: '' readOnly: true archived: type: - boolean - 'null' title: Archived default: false description: >- In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document. _id: type: string title: Document ID readOnly: true description: >- 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. type: type: string title: Document Type readOnly: true description: 'The document type’s name: always this type’s.' createdAt: type: - string - 'null' format: date-time title: Created At readOnly: true description: When it was created (ISO 8601). updatedAt: type: - string - 'null' format: date-time title: Updated At readOnly: true description: When it last changed (ISO 8601). aposShareKey: type: - string - 'null' description: >- 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. example: k3v9x2m7q1z8w4p6 readOnly: true required: - title - provider - category - purpose - _id - type description: Cookie content type x-fetchski-always-sent: - slug RichTextMax1Area: type: object description: >- Content made of widgets, as the site stores it: send `{ "items": [ … ] }`, one object per widget, top to bottom. It takes `@apostrophecms/rich-text` widgets; an item of any other type is dropped. At most 1. Writing it replaces the whole area. properties: metaType: type: string enum: - area description: Always `area`. _id: type: string description: 'The area’s id, set by the site: leave it out when you write one.' items: type: array description: >- The widgets, top to bottom. Each is an object with its `type` and that widget’s own fields; `_id` and `metaType` may be left out (the site sets them). items: $ref: '#/components/schemas/RichTextWidget' maxItems: 1 additionalProperties: true example: items: - type: '@apostrophecms/rich-text' content:

Hello from the API.

ApiError: type: object description: >- An error answer: the error’s name, a message saying what is wrong, and details by error. required: - name properties: name: type: string description: >- The error’s name: `invalid`, `required`, `unauthorized`, `forbidden`, `notfound`, `conflict`, `locked`, `tooManyRequests`, `error` (a server failure)… message: type: string description: What is wrong, and how to fix it. data: type: object additionalProperties: true description: >- Details, by error: `errors` (one entry per field problem, each with its `path`), `retryAfter` (seconds, on 429), `permission`… RichTextWidget: type: object properties: type: type: string enum: - '@apostrophecms/rich-text' description: 'The widget’s type: always `@apostrophecms/rich-text`.' _id: type: string description: >- The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there. metaType: type: string enum: - widget description: Always `widget`. content: type: string format: html description: >- The text as HTML, e.g. `

Our story

It began with one idea.

`. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest. example:

Hello from the API.

sectionCss: type: - object - 'null' description: >- CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and [data-theme="light"] & work inside a slot. properties: slots: type: object additionalProperties: type: string description: The CSS typed into each part slot, by slot name. css: type: string description: 'The compiled CSS (read only: rebuilt from `slots`).' mark: type: string description: The site’s check mark for `css` (read only). title: Custom CSS required: - type description: >- A `@apostrophecms/rich-text` widget: its `type` and its own fields. A field left out takes its default. additionalProperties: true responses: BadRequest: description: 'The request is not valid: `message` says what to change.' content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: The credential is missing or not accepted. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: The caller may not do this. content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: Nothing matches, or the caller may not see it. content: application/json: schema: $ref: '#/components/schemas/ApiError' InternalServerError: description: 'The site failed: `message` is the generic “An error occurred.”' content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- Paste your API key as the CMS showed it: `fsk___` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public. BearerAuth: type: http scheme: bearer description: >- A person’s bearer token, from **Signing in (people)** → `POST /@apostrophecms/login/login`. Apps use an API key instead. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.