v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Step

Steps.update

Modifies Step or Steps with given id(s)

patch/entities/Steps/{id}

Path parameters

idstring uuid required

ID of Step to update

Query parameters

validation-levelinteger

Specify validation level of Step on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

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.

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.

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

Modification confirmation. Returns resulting Step

successboolean

True when response 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
  }
}