Auth API · stations

Rename a station — what the device and Settings › Stations call it

PATCH /api/auth/stations/{organizationId}/{stationId}

403 ViewNotOpened for a station of a view the caller's roles do not open, 404 StationNotFound for an id no station of the organization has, 400 InvalidStation for a malformed name. Appends auth.station-renamed. Idempotent by content: the name the station already has is acknowledged and appends nothing.

Access

Requires a signed-in session: An owner or admin of the organization, or a member whose roles open the station's view, checked against its membership by the route (the BetterAuth session)

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: the name the station already has is acknowledged and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

  • auth.station-renamed

What a fact is: Facts and the journal.

AI agent tool

No agent tool. A station's name is what the people at the device read, changed in Settings › Stations; the MCP server does not reach the auth service.

Connecting an agent: AI agents.

Example

From Set up a station and unlock it with a PIN, step 5: Rename it.

curl
curl -X PATCH 'https://auth.getmanifold.io/api/auth/stations/org_01a1586e-f9f6-7a8b-9c7d-6e5f4a3b2c1d/stn_01a1586e-f9f6-7a8b-9c7d-6e5f4a3b2c1d' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Packing bench 2"
}'
JavaScript (fetch)
const response = await fetch("https://auth.getmanifold.io/api/auth/stations/org_01a1586e-f9f6-7a8b-9c7d-6e5f4a3b2c1d/stn_01a1586e-f9f6-7a8b-9c7d-6e5f4a3b2c1d", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "Packing bench 2"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "name": "Packing bench 2"
}
Response · 200 · application/json
{
  "stationId": "stn_01a1586e-f9f6-7a8b-9c7d-6e5f4a3b2c1d",
  "view": "pick-pack",
  "locationId": "loc_01a15852-46d1-7a3b-9c0d-1e2f3a4b5c6d",
  "name": "Packing bench 2",
  "enrolledAt": "2026-08-17T09:00:00.000Z",
  "enrolledBy": "usr_01a15869-1d2e-7f3a-8b4c-5d6e7f8a9b0c"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: auth-service.openapi.json. Base URL https://auth.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

400

RefusalWhat it meansWhat to do
InvalidStation reason The request was refused. reason says why.Fix the request. Sending it again unchanged gets the same answer.

401

RefusalWhat it meansWhat to do
Unauthorized reason The token is missing, expired or not one Manifold issued.Get a fresh token and send the call again.
TokenAlreadyUsed tokenId A single-use app token was already spent.Mint a new token for this call.

402

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat to do
NotAMember The person is not a member of this organization.Check the organization, or invite them first.
ViewNotOpened view The request was refused, and nothing changed.The caller may not do this. Use a token whose roles allow it.
TenantRequired userId The token names no organization.Choose the organization, then get a new token.
ScopeRequired required The token's roles do not grant the scope this call needs.Ask an owner or admin for a role that grants it.

404

RefusalWhat it meansWhat to do
StationNotFound stationId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
MirroredFromSource source This area is fed by your source system until the organization goes live.Make the change in the source system, or go live first.

503

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again shortly.

How refusals work everywhere: Errors.

Used in