Skip to content
YoPrintDevelopers

Reorder job presets

Open .md

PUT/v1/api/store/{team_slug}/setting/job_preset/arrange

v1Operation ID v1_public_job_preset_arrange

Sets the position of the presets you list; the list sorts by it, lowest first. Presets you leave out keep their position. Reordering is not an edit: each preset keeps its updated_at.

Returns the whole list in its new order.

Permission

Needs the Manage Settings permission. The team owner always has it.

Business rules

  • All positions are saved together; an unknown id fails the whole request with 404.

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.

  • itemsarray of objectsrequired
    • At least 1 item
    Fields of each item (2)
    • idstringrequired

      A job preset's id.

    • positionnumberrequired

      Its new sort position.

Response

200Successful response.

  • dataarray of objectsrequired
    Fields of each item (12)
    • assigned_usersarray of objectsrequired

      The people on the job itself. Jobs made from the preset get the ones still on your team.

      Fields of each item (4)
      • avatar_urlstring | nullrequired

        Their profile picture, or null.

      • idstringrequired
      • namestringrequired
      • removedbooleanrequired

        True when the person was deleted or is no longer on your team. They stay listed until someone takes them off; jobs made from the preset leave them out.

    • idstringrequired
    • is_validbooleanrequired

      False when a service, saved location, or task preset it uses was deleted, or a service option no longer exists.

    • mockuparray of objectsrequired

      Mockup images, in their order.

      Fields of each item (19)
      • collectionstringrequired
        • One of: "mockup", "production_file"
      • created_atstring (date-time)required

        When the file record was made: the upload time, or for a duplicated preset, when it was copied.

      • custom_propertiesobject | arrayrequired
      • file_namestringrequired
      • idstringrequired

        The file's id: use it in update and delete file rows.

      • is_imagebooleanrequired
      • job_preset_idstringrequired

        The preset the file belongs to.

      • job_servicearray of stringsrequired

        The ids of this preset's service lines the file belongs to. A job made from the preset links its copy to the matching new services.

      • mime_typestring | nullrequired
      • namestring | nullrequired

        The display name.

      • positioninteger | nullrequired

        Where the file sorts, lowest first.

      • previewobject | nullrequired

        Preview image links small, medium and large (250, 800 and 1200 px), or null when there is no preview.

      • show_in_pdfboolean | nullrequired

        Null when it was never set.

      • sizeintegerrequired

        Bytes.

      • source_media_idnullrequired

        Always null on a preset's files.

      • urlstring | nullrequired

        Where to download the file.

      • view_urlstring | nullrequired

        A signed link to view the file. It expires: read it fresh, and don't store it.

      • dimensionsobject | null

        Pixel size of an image, read from its header; null for other files and for images uploaded before the size was recorded.

        Child fields (2)
      • preview_statestring

        ready: the preview links work. processing: an image over 10 MB whose stored preview a worker is still making (seconds); read the file again, or in the web app wait for media.preview_state_changed on the team channel. too_large: an image over 120 megapixels; it never gets a preview. failed: the worker gave up. none: not an image.

        • One of: "ready", "processing", "too_large", "failed", "none"
    • namestringrequired
    • needs_reviewbooleanrequired

      True when the preset needs review (shown as "Needs review" in the web app):

      • is_valid is false (a service, service option, saved location, or task preset was deleted)
      • A team member assigned to one of its tasks was deleted or left the team (assignees on the job itself do not trigger review)

      A preset that needs review still saves. Creating a job from it omits missing tasks and removed teammates.

    • notestring | nullrequired
    • pipelinearray of objectsrequired

      The tasks.

      Fields of each item (11)
      • assigned_usersarray of objects
      • idstring
      • is_validboolean
      • namestring | null
      • notestring | null
      • pipelineobject | null

        The task preset it follows, as GET /v1/api/store/{team_slug}/setting/pipeline/{hash_id} returns it: id, label, color, version, enable, trashed, and its statuses (deleted ones included).

        Child fields (7)
        • colorstring
        • enableboolean
        • idstring
        • labelstring
        • statusesarray of objects
          Fields of each item (9)
          • colorstringrequired
          • customer_labelstringrequired

            What customers see in the customer portal. When none is set: Pending for start, In Progress for in_progress and pre_production, Completed for end.

          • idstringrequired
          • labelstringrequired
          • positionintegerrequired

            Sort order within the list, lowest first.

          • rolestringrequired

            Which list the status belongs to:

            • order: sales orders
            • quote: quotes
            • job: jobs
            • purchase_order: purchase orders
            • shipment: shipments
            • customer_message: message threads
            • pipeline: tasks within a task preset
            • One of: "order", "quote", "job", "purchase_order", "shipment", "customer_message", "pipeline"
          • trashedbooleanrequired

            True for a deleted status. Only the full list includes deleted ones.

          • typestringrequired

            The stage of the status in the workflow: start (first status in the list), pre_production, in_progress, or end (final status).

            • One of: "start", "pre_production", "in_progress", "end"
          • pipeline_idstring

            The task preset, for pipeline statuses only. Absent for every other role.

        • trashedboolean
        • versioninteger
      • pipeline_colorstring | null

        The task preset's color.

      • pipeline_idstring
      • pipeline_namestring | null

        The task preset's name.

      • positioninteger

        0 when none was sent.

      • trashedboolean

        True when its task preset was deleted.

    • positionstringrequired

      Sort order within the preset list, lowest first. A decimal string, such as "1.0000000000000000"; parse it as a decimal.

    • production_filearray of objectsrequired

      Production files, in their order.

    • servicearray of objectsrequired

      The service lines.

      Fields of each item (11)
      • versioninteger
        • Always 1
      • customer_notestring | null
      • idstring
      • locationobject

        type, display_name and trashed (true when a saved location was deleted), plus id for a saved location or name for a custom one.

      • notestring | null
      • optionstring | null
      • positioninteger
      • review_reasonstring | null

        Why the line needs review: its service was deleted, the service no longer has this option, or its saved location was deleted. Null when the line is fine.

        • One of: "service_removed", "option_removed", "location_removed"
      • service_idstring
      • service_namestring | null
      • validboolean

        False when review_reason is set.

    • updated_atstring (date-time) | nullrequired

      When the preset was last edited ("Last edited" in the web app). Every save changes it, even one that changes only its lines; reordering presets doesn't.

  • 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.

    When
    Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.
    Fix
    Use the key of a member whose role has Manage Settings, or the owner's.

  • 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.

    When
    An id is not one of your team's job presets.
    Fix
    Use ids from the list.

  • 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; bulk_validation_payload_failed names the failing item's bid and its fields.

    When
    items is empty, or an item has no id or numeric position (validation_failed).
    Fix
    Send at least one {id, position} pair.

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com