Skip to content

Reorder tasks

Open .md

POST/v1/api/store/{team_slug}/work_pipeline/bulk_update_position

v1Operation ID v1_public_work_pipeline_bulk_update_position

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.

Permission

Any member of the team. No sales order permission is checked.

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

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Request body

application/json, required.

The body is an array of objects.

  • idstringrequired

    The task. Each task at most once.

  • positionintegerrequired

    The new position. Lower comes first.

    • Minimum -2147483648
    • Maximum 2147483647

Response

200Successful response.

  • dataarray of objectsrequired
    Fields of each item (24)
    • assigned_usersarray of objects

      Who is assigned.

      Fields of each item (3)
    • created_atstring (date-time)
    • due_datestring (date-time) | null

      Task due date. ISO 8601 with offset, or null.

    • idstring

      The task.

    • job_idstring

      The job.

    • job_is_rushboolean | integer | null
    • job_item_countnumber | null
    • job_namestring | null
    • The job number with its prefix.

    • job_status_idstring | null

      The job's current status.

    • namestring
    • notestring | null
    • order_idstring

      The order.

    • order_namestring | null
    • order_scoped_idstring | null

      The order number.

    • The task preset it comes from.

    • positioninteger

      Order among tasks; lower comes first. 0 when unset.

    • A summary of the job's order.

      Child fields (14)
    • start_datestring (date-time) | null

      Task start. ISO 8601 with offset, or null.

    • statusobject

      A status: label, kind and place in the list.

      Child fields (9)
      • colorstring | null

        Hex color.

      • idstring

        The status.

      • labelstring
      • Only on the statuses of a task preset (role pipeline): the task preset. Absent on other statuses.

      • positioninteger

        Its place in the team's list: sort by it to find the next status.

      • rolestring

        Which list it belongs to: job for job statuses, pipeline for the statuses of a task preset.

        • One of: "order", "quote", "job", "purchase_order", "shipment", "customer_message", "pipeline"
      • trashedboolean

        The status was deleted.

      • typestring

        The kind of status: start (Pending), pre_production and in_progress (In Progress), end (Completed).

        • One of: "start", "pre_production", "in_progress", "end"
    • status_completion_datestring (date-time) | null

      When it reached a Completed status. ISO 8601 with offset, or null.

    • status_idstring

      The task's status (a status of its task preset).

    • status_last_change_datestring (date-time) | null

      When the status last changed. ISO 8601 with offset, or null.

    • updated_atstring (date-time)
  • statusintegerrequired
  • successbooleanrequired

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, with unauthorized or user_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_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_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 in error.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.
  • POSTFilter tasks/v1/api/store/{team_slug}/work_pipeline/filter
  • PUTUpdate a task/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}