Create a task preset

POST/v1/api/store/{team_slug}/setting/pipeline

v1Operation ID v1_public_pipeline_store

Creates a task preset with three statuses and returns it, statuses included: Pending (the start status), Started (in progress) and Completed (the end status). Change them with the status operations.

A new preset is off (enable: false) unless you send enable: true.

Task presets (called pipelines in the API) are named sets of statuses that a task moves through, for example Pending, Started, Completed. The tasks on a job each follow a preset, and services can be linked to presets. Every answer includes the preset's statuses. Change them with the status operations: add, rename, reorder or remove them with Save a set of status changes.

Permission

Needs the Manage Settings permission.

Business rules

• label is required and must not match another task preset that isn't deleted.
• color, when sent, is a hex color.

Side effects

• Creates the statuses Pending, Started and Completed for the preset.

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.

• labelstringrequired

  Unique among the team's task presets that aren't deleted.

• colorstring

  A hex color: # and 3 or 6 hex digits, such as #1976d2. Defaults to #FFFFFF.

• enableboolean

  Defaults to false: send true to turn it on.

Response

200Successful response.

• dataobjectrequired
  Child fields (7)

  • colorstringrequired

    A hex color.

  • enablebooleanrequired
  • idstringrequired
  • labelstringrequired
  • statusesarray of objectsrequired

    The preset's statuses, removed ones included (trashed: true). They are not sorted: order them by position.

    Fields of each item (9)

    • colorstringrequired
    • customer_labelstringrequired

      The name customers see. When none was set: Pending, In Progress or Completed, by type.

    • idstringrequired

      The status id, as task status changes take it.

    • labelstringrequired

      The status name people see.

    • pipeline_idstringrequired

      The task preset's id.

    • positionintegerrequired

      The order of the status in the preset, from 0.

    • rolestringrequired

      Always pipeline for task statuses.

    • trashedbooleanrequired

      True for a removed status. Removed statuses stay in the list.

    • typestringrequired

      start: where a new task begins. in_progress: working. end: the task is done.

      • One of: "start", "in_progress", "end"
  • trashedbooleanrequired

    True for a deleted task preset.

  • versionintegerrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 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 permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 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

  label is missing or already used, or color is not a hex color. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

• GETList the task statuses of a task preset/v1/api/store/{team_slug}/setting/status/pipeline/{hash_id}
• POSTSave a set of status changes/v1/api/store/{team_slug}/setting/status/{status_reference}

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/pipeline' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "color": "#1976d2",    "enable": true,    "label": "Screen printing"  }'

Example response 200

Response

{
  "data": {
    "color": "#1976d2",
    "enable": true,
    "id": "SyqthLPEGyJQGY",
    "label": "Screen printing",
    "statuses": [
      {
        "color": "#1976d2",
        "customer_label": "Pending",
        "id": "ta5ib44WIIqi1X",
        "label": "Pending",
        "pipeline_id": "SyqthLPEGyJQGY",
        "position": 0,
        "role": "pipeline",
        "trashed": false,
        "type": "start"
      },
      {
        "color": "#4caf50",
        "customer_label": "In Progress",
        "id": "v4teCIco0ZHebU",
        "label": "Started",
        "pipeline_id": "SyqthLPEGyJQGY",
        "position": 1,
        "role": "pipeline",
        "trashed": false,
        "type": "in_progress"
      },
      {
        "color": "#424242",
        "customer_label": "Completed",
        "id": "V4RV92MCWxFIjQ",
        "label": "Completed",
        "pipeline_id": "SyqthLPEGyJQGY",
        "position": 2,
        "role": "pipeline",
        "trashed": false,
        "type": "end"
      }
    ],
    "trashed": false,
    "version": 1
  },
  "status": 200,
  "success": true
}