Statuses

API reference › Team settings

The status lists for sales orders, quotes, jobs, purchase orders, shipments, message threads and task presets. Each list has a starting and an ending status.

16 operations

• POSTCreate a status/v1/api/store/{team_slug}/setting/statusAdds an in-between status (type: in_progress) to one list: sales orders, quotes, jobs, purchase orders, shipments, message threads, or the tasks of a task preset.
• GETList every status, including deleted ones/v1/api/store/{team_slug}/setting/statusReturns every status the team has, for every list, including deleted ones (trashed: true).
• GETList message thread statuses/v1/api/store/{team_slug}/setting/status/customer_messageReturns the team's message thread (role customer_message) statuses.
• GETList job statuses/v1/api/store/{team_slug}/setting/status/jobReturns the team's job (role job) statuses.
• GETList the task statuses of a task preset/v1/api/store/{team_slug}/setting/status/pipeline/{hash_id}Returns the statuses of one task preset (role pipeline): the steps a task moves through.
• GETList purchase order statuses/v1/api/store/{team_slug}/setting/status/purchase_orderReturns the team's purchase order (role purchase_order) statuses.
• GETList purchase order statuses, without the ending one/v1/api/store/{team_slug}/setting/status/purchase_order_without_endReturns the team's purchase order (role purchase_order) statuses.
• GETList quote statuses/v1/api/store/{team_slug}/setting/status/quoteReturns the team's quote (role quote) statuses.
• GETList sales order statuses/v1/api/store/{team_slug}/setting/status/sales_orderReturns the team's sales order (role order) statuses.
• GETList shipment statuses/v1/api/store/{team_slug}/setting/status/shipmentReturns the team's shipment (role shipment) statuses.
• GETGet a status/v1/api/store/{team_slug}/setting/status/{status_reference}Returns one status by its id.
• POSTSave a set of status changes/v1/api/store/{team_slug}/setting/status/{status_reference}Creates, updates and deletes several statuses in one request, all or nothing.
• PUTUpdate a status/v1/api/store/{team_slug}/setting/status/{status_reference}Changes a status's label, color, position or customer portal label.
• PATCHUpdate a status without checks/v1/api/store/{team_slug}/setting/status/{status_reference}Use PUT to change a status.
• DELETEDelete a status/v1/api/store/{team_slug}/setting/status/{status_reference}Deletes an in-between (in_progress) or ending (end) status.
• PATCHRestore a deleted status/v1/api/store/{team_slug}/setting/status/{id}/restoreBrings back a deleted status, with its label, color, type and position.