COcoevera
Product

ProductPriceLists.update

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

patch/entities/ProductPriceLists/{id}

Request

Path parameters

idstring uuid required

Id of the ProductPriceList 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-form description of the price list.

end_datestring date

Date when the price list expires. Empty means open-ended.

is_activeboolean

Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.

namestring

Name of the entity and its default text representation.

rulesobject

Filter expression — a FieldFilter JSON object — deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/f/#FieldFilter

start_datestring date

Date when the price list becomes active. Empty means immediately.

type1 | 2

Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).

Integer enum value: 1 - Standard, 2 - Scheduled

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "description": "string",
  "end_date": "2019-01-01",
  "name": "string",
  "start_date": "2019-01-01",
  "type": 1,
  "revision": 1
}

Response

The changed ProductPriceList 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",
    "end_date": "2019-01-01",
    "name": "string",
    "start_date": "2019-01-01",
    "type": 1,
    "revision": 1
  }
}

Changes

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