# Update a task preset

```http
PUT https://secure.yoprint.com/v1/api/store/{team_slug}/setting/pipeline/{hash_id}
```

- API version: v1
- Operation ID: `v1_public_pipeline_update_put`
- Section: Team settings › [Task presets](https://developer.yoprint.com/reference/task-presets.md)
- Web page: https://developer.yoprint.com/reference/task-presets/v1-pipeline-update-put/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Changes a task preset's label, color or on/off state, and returns it with its statuses. Statuses are changed with the status operations.

## Permission

Needs the Manage Settings permission.

## Business rules

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

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The task preset's `id`: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 `page_not_found`. Example `SyqthLPEGyJQGY`.

## Request body

Content type `application/json`, required.

Fields:

- `color` (string, optional): A hex color: `#` and 3 or 6 hex digits, such as `#1976d2`.
- `enable` (boolean, optional): Turns it on or off.
- `label` (string, optional): Unique among the team's task presets that aren't deleted.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/pipeline/SyqthLPEGyJQGY' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "Screen printing (2 colors)"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `color` (string, required): A hex color.
  - `enable` (boolean, required)
  - `id` (string, required)
  - `label` (string, required)
  - `statuses` (array of objects, required): The preset's statuses, removed ones included (`trashed: true`). They are not sorted: order them by `position`.
    - Each item:
      - `color` (string, required)
      - `customer_label` (string, required): The name customers see. When none was set: `Pending`, `In Progress` or `Completed`, by `type`.
      - `id` (string, required): The status id, as task status changes take it.
      - `label` (string, required): The status name people see.
      - `pipeline_id` (string, required): The task preset's id.
      - `position` (integer, required): The order of the status in the preset, from 0.
      - `role` (string, required): Always `pipeline` for task statuses.
      - `trashed` (boolean, required): True for a removed status. Removed statuses stay in the list.
      - `type` (string, required): `start`: where a new task begins. `in_progress`: working. `end`: the task is done. One of: `"start"`, `"in_progress"`, `"end"`.
  - `trashed` (boolean, required): True for a deleted task preset.
  - `version` (integer, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "color": "#1976d2",
    "enable": true,
    "id": "SyqthLPEGyJQGY",
    "label": "Screen printing (2 colors)",
    "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
}
```

## Errors

- `401` The 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`.
- `403` You 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.
- `404` Not 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: No task preset with that id on this team (`error.code` is null and `error.message` starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both `page_not_found`). Fix: Use an `id` from the list operation and check the team slug.
- `422` The 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 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

- [Show a task preset](https://developer.yoprint.com/reference/task-presets/v1-pipeline-show.md): `GET /v1/api/store/{team_slug}/setting/pipeline/{hash_id}`