Writes

Beyond reading, @uidu/client exposes authoring functions — createX / updateX / deleteX — for provisioning and editing workspace content. The uidu CLI wraps the same functions as <entity> create|update|delete.

Auth: every write needs a Bearer token

Writes authenticate as an account (apiKey), so they run on your server — a server action, route handler, RSC or script — or from the CLI, never in the browser. That includes the visitor-facing ones: a form response or a donation is submitted from a server action. See Authentication.

Input shape

Every mutation takes a single input object. create carries attributes; update adds the id; delete takes just the id:

import { createCourse, updateCourse, deleteCourse } from '@uidu/client';

await createCourse(client, { input: { attributes: { name: 'Onboarding' } } });
await updateCourse(client, { input: { id, attributes: { name: 'Onboarding v2' } } });
await deleteCourse(client, { input: { id } });

From the CLI:

uidu courses create --name "Onboarding"
uidu courses update <id> --attributes '{"name":"Onboarding v2"}'
uidu courses delete <id>

Always check errors

Mutations resolve to a payload with an errors array and the affected record. A non-empty errors means a validation failure — the record is unchanged.

const result = await createCourse(client, { input: { attributes: { name: 'Onboarding' } } });
if (result?.errors?.length) {
  // handle validation messages (result.errors[].name)
} else {
  result?.course?.id;
}

The CLI exits non-zero and prints the errors when the array is non-empty.

Capability matrix

Not every entity supports every verb — this reflects what the client and CLI expose today, generated from the CLI's resource registry. Beyond these, the CMS (page, block, field) and provisioning (workspace, project) commands have their own verbs — see CLI commands — and any tool-flagged backend action can be run with executeAction / uidu tools call <key>.

See the CLI commands for the read verbs too, and Schema for the *Attributes input fields per entity.

API at a glance

Every @uidu/client function in Provisioning & actions, generated from the source — the full reference has the rest of the SDK.