Skip to main content

Update printer

PATCH/v20/printers/{printerId}

Updates a printer by ID. Currently only the name attribute can be updated. The printer must belong to the authenticated account.

Uses JSON:API format for both request and response.

Authentication​

Requires HTTP Basic authentication with your API Credential ID and Token.

Content Type​

application/vnd.api+json

Path Parameters​

ParameterTypeRequiredDescription
printerIdstring (UUID)YesThe printer ID

Request Body​

{
  "data": {
    "type": "printers",
    "id": "f9d43179-9c10-4502-8f62-892740a65318",
    "attributes": {
      "name": "Back Kitchen"
    }
  }
}

Request Requirements​

  • data.type must be "printers"
  • data.id must match the printerId path parameter
  • attributes.name is required and must be a non-empty string
  • Only name can be updated — any other attributes in the request body will be rejected with a 400 error

Response​

200 — Updated printer (JSON:API)​

{
  "data": {
    "type": "printers",
    "id": "f9d43179-9c10-4502-8f62-892740a65318",
    "attributes": {
      "name": "Back Kitchen",
      "enabled": true,
      "legacyId": "legacy-printer-001",
      "billingPlan": "basic",
      "pendingPlanChange": null,
      "billingState": "active",
      "deactivationDate": null,
      "cooldownUntil": null,
      "jobCount": 142,
      "createdAt": "2026-01-15T08:00:00Z",
      "updatedAt": "2026-03-28T10:00:00Z"
    },
    "relationships": {
      "account": {
        "data": { "type": "accounts", "id": "c75c40ff-3263-4171-afe4-1e138f8ea616" }
      }
    }
  }
}

400 — Validation error​

Returned when the request body is invalid.

{
  "errors": [
    { "status": "400", "title": "Bad Request", "detail": "attributes.name is required and must be a non-empty string" }
  ]
}
{
  "errors": [
    { "status": "400", "title": "Bad Request", "detail": "Only the following attributes can be updated: name. Disallowed: enabled" }
  ]
}
{
  "errors": [
    { "status": "400", "title": "Bad Request", "detail": "data.id must match the printerId path parameter" }
  ]
}

403 — Account not found or disabled​

{
  "errors": [
    { "status": "403", "title": "Forbidden", "detail": "Account not found" }
  ]
}

422 — Printer is disabled​

Returned when the printer exists but is disabled. Enable the printer before making updates.

{
  "errors": [
    { "status": "422", "title": "Unprocessable Entity", "detail": "Printer is disabled. Enable the printer before making updates." }
  ]
}

404 — Printer not found​

Returned when the printer does not exist or belongs to a different account.

{
  "errors": [
    { "status": "404", "title": "Not Found", "detail": "Printer not found" }
  ]
}

401 — Not authorized​

Returned when the API credential is invalid, disabled, or missing.