COcoevera
Step

Steps.update

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

patch/entities/Steps/{id}

Request

Path parameters

idstring uuid required

Id of the Step record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

descriptionstring

Free-text description shown in the step UI.

has_readonly_formboolean

When true, the record form is read-only while a record is in this step.

has_version_incrementboolean

When true, transitioning a record into this step bumps its version counter.

lead_process_idstring uuid

Id of the lead process this step belongs to, or empty when the step is not part of a lead process.

namestring

Name of the entity and its default text representation.

percentinteger

Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.

quote_process_idstring uuid

Id of the quote process this step belongs to, or empty when the step is not part of a quote process.

sort_orderinteger

Position of the step within its pipeline or process; lower values appear first.

timeframeinteger

Expected number of days a record should spend in this step. Used to flag overdue records.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "description": "string",
  "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
  "name": "string",
  "percent": 1,
  "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
  "sort_order": 1,
  "timeframe": 1,
  "revision": 1
}

Response

The changed Step record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "description": "string",
    "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "percent": 1,
    "pipeline_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "timeframe": 1,
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.