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

# Steps.update

`PATCH /entities/Steps/{id}`

Modifies Step or Steps with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateStepInput
  - `description` string — Free-text description shown in the step UI.
  - `has_readonly_form` boolean — When true, the record form is read-only while a record is in this step.
  - `has_version_increment` boolean — When true, transitioning a record into this step bumps its version counter.
  - `lead_process_id` string, uuid — Id of the lead process.
  - `name` string — Name of the entity and its default text representation.
  - `percent` integer — Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
  - `quote_process_id` string, uuid — Id of the quote process.
  - `sort_order` integer — Position of the step within its pipeline or process; lower values appear first.
  - `timeframe` integer — Expected number of days a record should spend in this step. Used to flag overdue records.
  - `revision` integer — Revision when entity was lastly changed.
  - `documents` object[] — Files attached to the step (e.g. step-specific documentation or templates).
    - `id` string, uri
  - `step_checklists` object[] — Checklist items the user must complete before moving a record out of this step.
    - `id` string, uri

## Response `200`

Modification confirmation. Returns resulting Step

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Step
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `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.
    - `lead_process` string, uri — Lead process this step belongs to. Set when the step is part of a lead process. Relation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties.
    - `pipeline` string, uri — Opportunity pipeline this step belongs to. Set when the step is part of an opportunity pipeline. Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties.
    - `quote_process` string, uri — Quote process this step belongs to. Set when the step is part of a quote process. Relation to QuoteProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteProcess' object for properties.
    - `description` string — Free-text description shown in the step UI.
    - `has_readonly_form` boolean — When true, the record form is read-only while a record is in this step.
    - `has_version_increment` boolean — When true, transitioning a record into this step bumps its version counter.
    - `lead_process_id` string, uuid — Id of the lead process.
    - `name` string, required — Name of the entity and its default text representation.
    - `percent` integer — Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
    - `pipeline_id` string, uuid — Id of the opportunity pipeline.
    - `quote_process_id` string, uuid — Id of the quote process.
    - `sort_order` integer — Position of the step within its pipeline or process; lower values appear first.
    - `timeframe` integer — Expected number of days a record should spend in this step. Used to flag overdue records.
    - `revision` integer — Revision when entity was lastly changed.
    - `documents` string[] — Files attached to the step (e.g. step-specific documentation or templates).
    - `step_checklists` string[] — Checklist items the user must complete before moving a record out of this step.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)