Update Custom Order Status

PUT {{baseUrl}}/orders/statuses/:status_id

This endpoint allows you to update a custom order status by passing the status_id as a path parameter. Then, using the parameters available to be sent as body request.

:::danger[Important] All variables in the Update Custom Order Status body request are optional. At least one of the variables must be in the body request payload. Otherwise, an error will be shown if you send an empty body request payload. :::

orders.read_write - Orders Read & Write

Request Body

{"name"=>"<string>", "message"=>"<string>", "icon"=>"<string>", "sort"=>"<integer>", "is_active"=>true}

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","type":"custom","slug":"\u003cstring\u003e","message":"\u003cstring\u003e","color":"\u003cstring\u003e","icon":"\u003cstring\u003e","sort":"\u003cnumber\u003e","is_active":true,"original":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"},"parent":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"},"children":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","slug":"\u003cstring\u003e","type":"original","message":"\u003cstring\u003e","color":"\u003cstring\u003e","icon":"\u003cstring\u003e","sort":"\u003cnumber\u003e","is_active":true},{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","slug":"\u003cstring\u003e","type":"custom","message":"\u003cstring\u003e","color":"\u003cstring\u003e","icon":"\u003cstring\u003e","sort":"\u003cnumber\u003e","is_active":true}]}}