Reorder tasks
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/tasks/v1-work-pipeline-bulk-update-position.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
POST/
Sets the position of several tasks at once, as the web app does when you drag tasks on a board or within a job. Returns the updated tasks.
Positions only order tasks; they don't need to be consecutive. All rows save together or none do.
Business rules
- Each task may appear once: duplicates are a 422 "Duplicate work pipeline IDs are not allowed."
- Every id must be a task of your team, or nothing is saved: 422 "Work pipeline not found!"
Path parameters
Your team slug, shown as Team ID next to your API key in Profile.
- Example
your-team
- Example
Request body
application/json, required.
The body is an array of objects.
The task. Each task at most once.
The new position. Lower comes first.
- Minimum -2147483648
- Maximum 2147483647
Response
200Successful response.
Fields of each item (24)
assigned_usersarray of objectsWho is assigned.
Fields of each item (3)
avatar_urlstring | nullidstringThe user.
namestring
created_atstring (date-time)due_datestring (date-time) | nullTask due date. ISO 8601 with offset, or null.
idstringThe task.
job_idstringThe job.
job_is_rushboolean | integer | nulljob_item_countnumber | nulljob_namestring | nulljob_scoped_idstringThe job number with its prefix.
job_status_idstring | nullThe job's current status.
namestringnotestring | nullorder_idstringThe order.
order_namestring | nullorder_scoped_idstring | nullThe order number.
pipeline_idstringThe task preset it comes from.
positionintegerOrder among tasks; lower comes first. 0 when unset.
sales_orderobjectA summary of the job's order.
Child fields (14)
created_bystring | nullWho created the order.
cust_due_datestring (date-time) | nullOrder customer due (in-hand) date. ISO 8601 with offset, or null.
customer_idstring | nullThe customer.
customer_namestring | nulldue_datestring (date-time) | nullOrder production due date. ISO 8601 with offset, or null.
external_typestring | nullshopifywhen the order came from Shopify, else null.is_quotebooleanissue_datestring (date-time) | nullOrder issue date. ISO 8601 with offset, or null.
object_typestring | nullsales_orderorquote.ship_due_datestring (date-time) | nullOrder ship-by date. ISO 8601 with offset, or null.
shopify_deleted_externallybooleanshopify_deleted_externally_atstring (date-time) | nullWhen it was deleted in Shopify. ISO 8601 with offset, or null.
start_datestring (date-time) | nullOrder production start. ISO 8601 with offset, or null.
status_idstring | nullThe order status.
start_datestring (date-time) | nullTask start. ISO 8601 with offset, or null.
statusobjectA status: label, kind and place in the list.
Child fields (9)
colorstring | nullHex color.
customer_labelstringidstringThe status.
labelstringpipeline_idstringOnly on the statuses of a task preset (
rolepipeline): the task preset. Absent on other statuses.positionintegerIts place in the team's list: sort by it to find the next status.
rolestringWhich list it belongs to:
jobfor job statuses,pipelinefor the statuses of a task preset.- One of:
"order","quote","job","purchase_order","shipment","customer_message","pipeline"
- One of:
trashedbooleanThe status was deleted.
typestringThe kind of status:
start(Pending),pre_productionandin_progress(In Progress),end(Completed).- One of:
"start","pre_production","in_progress","end"
- One of:
status_completion_datestring (date-time) | nullWhen it reached a Completed status. ISO 8601 with offset, or null.
status_idstringThe task's status (a status of its task preset).
status_last_change_datestring (date-time) | nullWhen the status last changed. ISO 8601 with offset, or null.
updated_atstring (date-time)
Errors
401The API key is missing or wrong (
unauthenticated).403You are not allowed to do this.
api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only{"message": "Insufficient Permission"}. Other refusals use the error envelope, withunauthorizedoruser_is_not_authorized.404Not found.
page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's.code: null, with a message that starts "No query results for": there is no record with that id.422The request was refused and changed nothing.
validation_failedlists what to fix inerror.fields; other codes name a business rule, explained inerror.message. A few checks answer with only{"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answerconnect_timeout("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.- When
- A missing or non-integer
position, or an id that isn't a valid hash id (validation_failed, details inerror.fields). - Fix
- Send each task once with an integer position.
- When
- A duplicate id, or an id that isn't one of your team's tasks (
job_validation_error). - Fix
- Send each task of your team once.
Related
- POSTFilter tasks
/v1/ api/ store/ {team_slug}/ work_pipeline/ filter - PUTUpdate a task
/v2/ api/ store/ {team_slug}/ v2/ work_pipeline/ {hash_id}
