Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Product

ProductPriceLists.update

Modifies ProductPriceList or ProductPriceLists with given id(s)

patch/entities/ProductPriceLists/{id}

Path parameters

idstring uuid required

ID of ProductPriceList to update

Query parameters

validation-levelinteger

Specify validation level of ProductPriceList 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-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://graphql.api-doc.pipelinersales.com/latest/graphql/space/fieldfilter.doc.html

start_datestring date

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

type1 | 2

Distribution model of the price list (e.g. List, Promotion, Discount).

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

Modification confirmation. Returns resulting ProductPriceList

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