--- title: "Steps.update" method: PATCH path: "/entities/Steps/{id}" tags: ["Step"] --- # Steps.update `PATCH /entities/Steps/{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/Steps/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Changes fields of the Step record with the given id; fields left out keep their values. ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateStepInput: Field values to change on a Step record; fields left out keep their values. - `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 this step belongs to, or empty when the step is not part of a 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 this step belongs to, or empty when the step is not part of a 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, uuid: Id of the related CloudObjectStepRelation record. - `step_checklists` object[]: Checklist items the user must complete before moving a record out of this step. - `id` string, uuid: Id of the related StepChecklist record. ## Response `200` The changed Step record. - object - `success` boolean: True when the request succeeded; false on error. - `data` Step: Step of an opportunity pipeline, lead process or quote process that records move through. - `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. - `lead_process` string, uri: Lead process this step belongs to. Set when the step is part of a lead process. Related LeadProcess record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'LeadProcess' for its fields. - `pipeline` string, uri: Opportunity pipeline this step belongs to. Set when the step is part of an opportunity pipeline. 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. - `quote_process` string, uri: Quote process this step belongs to. Set when the step is part of a quote process. Related QuoteProcess record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'QuoteProcess' for its fields. - `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 this step belongs to, or empty when the step is not part of a 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 this step belongs to, or empty when the step is not part of a 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 - `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)