Add a printer to a site

PUT /printers/{printerId}

Add a printer to a site, or replace one (restoring it, when it was removed): its name, the print agent that reaches it, its language, media and connection (network-raw host and port, or an os-printer queue on the agent's computer), and the purposes it is the site's default for — saving it takes those purposes from the site's other printers.

Moving it to another site or print agent fails its queued jobs with the reason in the same commit (fulfillment.print-job-failed). 404 LocationNotFound for a site the organization does not have; 409 PrintAgentNotAtSite for an agent that is not the organization's, is enrolled at another site, or was revoked (asked of auth with the caller's token; 503 PrintAgentsUnavailable when auth does not answer). Appends fulfillment.printer-saved. Idempotent by content: the printer as it already stands appends nothing.

Access

Requires locations:write.

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

Retries

Idempotent by content: the printer as it already stands appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.print-job-failed
fulfillment.printer-saved

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_save_printer (Fulfillment: Save printer), in the printing toolset.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://fulfillment.getmanifold.io/printers/prn_01a15a10-2c00-7a11-8b22-3c4d5e6f7a8b' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Dispatch Zebra",
  "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
  "agentId": "pag_01a15a0f-9e00-7c33-8d44-5e6f7a8b9c0d",
  "language": "zpl",
  "media": {
    "widthMm": 50,
    "heightMm": 25,
    "dpi": 203
  },
  "connection": {
    "_tag": "network-raw",
    "host": "192.168.1.40",
    "port": 9100
  },
  "defaultFor": [
    "sku-label",
    "bin-label"
  ]
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/printers/prn_01a15a10-2c00-7a11-8b22-3c4d5e6f7a8b", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "Dispatch Zebra",
    "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
    "agentId": "pag_01a15a0f-9e00-7c33-8d44-5e6f7a8b9c0d",
    "language": "zpl",
    "media": {
      "widthMm": 50,
      "heightMm": 25,
      "dpi": 203
    },
    "connection": {
      "_tag": "network-raw",
      "host": "192.168.1.40",
      "port": 9100
    },
    "defaultFor": [
      "sku-label",
      "bin-label"
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "name": "Dispatch Zebra",
  "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
  "agentId": "pag_01a15a0f-9e00-7c33-8d44-5e6f7a8b9c0d",
  "language": "zpl",
  "media": {
    "widthMm": 50,
    "heightMm": 25,
    "dpi": 203
  },
  "connection": {
    "_tag": "network-raw",
    "host": "192.168.1.40",
    "port": 9100
  },
  "defaultFor": [
    "sku-label",
    "bin-label"
  ]
}

Response · 200 · application/json

{
  "id": "prn_01a15a10-2c00-7a11-8b22-3c4d5e6f7a8b",
  "name": "Dispatch Zebra",
  "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
  "agentId": "pag_01a15a0f-9e00-7c33-8d44-5e6f7a8b9c0d",
  "language": "zpl",
  "media": {
    "widthMm": 50,
    "heightMm": 25,
    "dpi": 203
  },
  "connection": {
    "_tag": "network-raw",
    "host": "192.168.1.40",
    "port": 9100
  },
  "defaultFor": [
    "sku-label",
    "bin-label"
  ],
  "removed": false,
  "createdAt": "2026-10-15T01:12:40.215Z",
  "updatedAt": "2026-10-15T01:12:40.215Z"
}

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: fulfillment-manager.openapi.json. Base URL https://fulfillment.getmanifold.io.

Errors

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

`401`

Refusal	What it means	What 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`

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

`403`

Refusal	What it means	What to do
`PrintAgentOnly` reason	This call is a print agent's alone, or a person's alone. `reason` says which.	Call it with the right credential.
`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`

Refusal	What it means	What to do
`LocationNotFound` locationId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`PrintAgentNotAtSite` agentId, locationId, reason	The printer names a print agent that is not enrolled at its site. `reason` says why: unknown, another site's, or revoked.	Choose one of the site's own print agents, or enrol one there.
`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.

`502`

Refusal	What it means	What to do
`InventoryUnavailable` reason	The inventory service did not answer, so nothing changed.	Send the same request again shortly.

`503`

Refusal	What it means	What to do
`PrintAgentsUnavailable` reason	Manifold could not check the print agent just now, so nothing was saved.	Send the same request again shortly.
`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

Print labels at a site, step 5: Add the printer
Print labels at a site, step 6: Save it again