Quote

QuoteProcesses.update

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

patch/entities/QuoteProcesses/{id}

Request

Path parameters

idstring uuid required

Id of the QuoteProcess 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

colorinteger

Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.

namestring

Name of the entity and its default text representation.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "color": 1,
  "name": "string",
  "revision": 1,
  "steps": [
    {
      "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 QuoteProcess 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",
    "color": 1,
    "name": "string",
    "revision": 1,
    "steps": [
      {
        "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
      }
    ]
  }
}

Changes

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