---
title: "AllowedPipelines.update"
method: PATCH
path: "/entities/AllowedPipelines/{id}"
tags: ["MasterRight"]
---

# AllowedPipelines.update

`PATCH /entities/AllowedPipelines/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/AllowedPipelines/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/AllowedPipelines/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Changes fields of the AllowedPipeline record with the given id; fields left out keep their values.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateAllowedPipelineInput: Field values to change on an AllowedPipeline record; fields left out keep their values.
  - `access_step_documents` boolean: When true, the user role can access documents attached to steps of this pipeline.
  - `master_right_id` string, uuid: Id of the user role.
  - `pipeline_id` string, uuid: Id of the pipeline the user role can use.
  - `revision` integer: Revision when entity was lastly changed.

## Response `200`

The changed AllowedPipeline record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` AllowedPipeline: Pipeline that a user role is allowed to use, optionally with access to the documents of its steps.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `master_right` string, uri, required: User role granted access to the pipeline. Related MasterRight record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'MasterRight' for its fields.
    - `pipeline` string, uri, required: Pipeline the user role can use. Related Pipeline record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Pipeline' for its fields.
    - `access_step_documents` boolean: When true, the user role can access documents attached to steps of this pipeline.
    - `master_right_id` string, uuid, required: Id of the user role.
    - `pipeline_id` string, uuid, required: Id of the pipeline the user role can use.
    - `revision` integer: Revision when entity was lastly changed.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)