COcoevera
Step

Steps.batch_create_or_update

Creates or updates Step records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/Steps/batch-modify

Request

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.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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