Update a price book

Operation ID: updatePriceBook

Group: Accounting › Price Books

Open in the interactive reference

PATCH /accounting/price-books/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a price book with the fields you send. A field you leave out keeps its current value.

Use the price book's id, not its priceBookNumber.

You can't change isStandard or priceBookNumber with this endpoint. The response contains only the price book's id. Read the updated record with GET accounting/price-books/:id.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the price book you want to update.

Request body

Required, application/json: updatePriceBookInput.

Field Type Required Description
priceBookName string no A new display name. Omit to leave it unchanged. It must stay unique within the tenant, compared case-insensitively. The price book's own current name is not a collision.
active boolean no A new active flag. Omit to leave it unchanged.
description string no A new description. Omit to leave it unchanged.
dataSource string no A new data source. Omit to leave it unchanged. 
{
  "priceBookName": "<priceBookName>",
  "active": true,
  "description": "<description>",
  "dataSource": "<dataSource>"
}

Response

200 Success

Under data (updatePriceBookOutput):

Field Type Required Description
id string yes The unique identifier for the updated price book. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
DUPLICATE_NAME 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses