---
updatedAt: 2026-07-03T01:53:36.000Z
agentTools:
  projectIndex: https://x-series-api.lightspeedhq.com/llms.txt
---

# Update a service status

Partially updates a custom service status. Only provided fields are updated.

System default statuses cannot be modified.

**Only available with the Service Orders module enabled.**

🔒 Requires: `services:write` scope

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "email": "x-series.api@lightspeedhq.com",
      "name": "Lightspeed Developer Relations",
      "url": "https://developers.retail.lightspeed.app"
    },
    "description": "Lightspeed Retail (X-Series) API.",
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "termsOfService": "https://developers.lightspeedhq.com/terms",
    "title": "API 2026-07",
    "version": "2026-07"
  },
  "servers": [
    {
      "url": "https://{domain_prefix}.retail.lightspeed.app/api/2026-07",
      "variables": {
        "domain_prefix": {
          "default": "example",
          "description": "Domain prefix of the store to be operated on"
        }
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "externalDocs": {
    "description": "List of tz database time zones",
    "url": "https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"
  },
  "tags": [
    {
      "description": "Service orders and Job management",
      "name": "Service Orders"
    }
  ],
  "paths": {
    "/service_statuses/{id}": {
      "parameters": [
        {
          "description": "ID of the service status",
          "in": "path",
          "name": "id",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "patch": {
        "description": "Partially updates a custom service status. Only provided fields are updated.\n\nSystem default statuses cannot be modified.\n\n**Only available with the Service Orders module enabled.**\n\n🔒 Requires: `services:write` scope",
        "operationId": "UpdateServiceStatus",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "display_order": {
                    "description": "New display order. Can be set to null to clear it.",
                    "nullable": true,
                    "type": "integer"
                  },
                  "name": {
                    "description": "New human-readable name for the status. If provided, must not be blank.",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "created_at": "2026-03-30T19:28:37.155851Z",
                  "display_name": "newest custom edited?",
                  "display_order": 4,
                  "id": "2038699938241933312",
                  "retailer_id": "00000000-0001-0001-0001-000000000001",
                  "status_key": "CUSTOM",
                  "system_default": false,
                  "updated_at": "2026-03-31T18:23:07.400648Z"
                },
                "schema": {
                  "$ref": "#/components/schemas/ServiceStatusDetails"
                }
              }
            },
            "description": "Service status updated successfully"
          },
          "400": {
            "content": {
              "application/json": {
                "example": {
                  "error": "name cannot be empty"
                },
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Bad request — name is provided but blank"
          },
          "401": {
            "content": {
              "application/json": {
                "example": {
                  "error": "Access token is not valid"
                },
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "example": {
                  "error": "cannot modify system status"
                },
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Forbidden — missing `services:write` scope, or attempting to modify a system default status"
          },
          "404": {
            "content": {
              "application/json": {
                "example": {
                  "error": "job status not found"
                },
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Not Found"
          },
          "409": {
            "content": {
              "application/json": {
                "examples": {
                  "duplicate_display_order": {
                    "value": {
                      "error": "a status already exists with this display order"
                    }
                  },
                  "duplicate_name": {
                    "value": {
                      "error": "a status already exists with this name"
                    }
                  }
                },
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Conflict — a status with this name or display order already exists"
          }
        },
        "summary": "Update a service status",
        "tags": [
          "Service Orders"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ServiceStatusDetails": {
        "description": "Details of a custom service status assigned to a service order.",
        "nullable": true,
        "properties": {
          "created_at": {
            "description": "The date and time the status was created.",
            "format": "date-time",
            "type": "string"
          },
          "display_name": {
            "description": "Human-readable name of the status.",
            "type": "string"
          },
          "display_order": {
            "description": "The order in which this status appears in the UI. Null if not set.",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "The unique ID of the status.",
            "type": "string"
          },
          "retailer_id": {
            "description": "The retailer this status belongs to.",
            "type": "string"
          },
          "status_key": {
            "description": "The underlying key mapping this status to a system status (e.g. NEW, IN_PROGRESS).",
            "type": "string"
          },
          "system_default": {
            "description": "Whether this is a system-managed default status.",
            "type": "boolean"
          },
          "updated_at": {
            "description": "The date and time the status was last updated.",
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "description": "Bearer Token for API authentication.",
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```