Files
dashback/docs/api/routes/printeragent/_id.patch.md
2026-10-31 20:28:37 +01:00

1.2 KiB

PATCH /printeragent/{id}

Protected. Requires a valid session cookie (credentials: 'include').

Update printer agent

Updates name and/or display order (sort) of a printer agent.

Path parameters

Param Required Type Description
id yes integer

Body (JSON)

Field Required Type Description
name no string
sort no integer
enabled no boolean
{
  "name": "…",
  "sort": 1,
  "enabled": true
}

Response 200

Updated printer agent

{
  "printeragent": {
    "id": 1,
    "companyId": 1,
    "name": "…",
    "token": "…",
    "pairingpin": "…",
    "pairedAt": "…",
    "agentversion": "…",
    "lastseenAt": "…",
    "updatedAt": "…",
    "sort": 1,
    "enabled": true
  }
}

Errors

Status Description
400 No company selected or invalid input — {"error":"…"}
401 Unauthorized — {"error":"…"}
403 Not authorized — {"error":"…"}
404 Printeragent not found — {"error":"…"}

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.