Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Price books

Update price book

Update the details of an existing price book.

put/v1/price-books/{id}

Path parameters

idstring required

Request body

namestring

Price book name.

descriptionstring nullable

Price book description.

user_role_idsstring[]

List of user role IDs that have access to this price book.

Example request

{
  "name": "Enterprise pricing"
}

Response

idstring required

Price book ID.

namestring required

Price book name.

descriptionstring nullable required

Price book description.

user_role_idsstring[] required

List of user role IDs that have access to this price book.

created_atstring date-time required

Price book creation date. UTC date time string in the ISO 8601 format.

updated_atstring date-time required

Price book last update date. UTC date time string in the ISO 8601 format.

Example response

{
  "id": "prib_DKL4Xcb5VSa8CQ",
  "name": "Enterprise pricing",
  "created_at": "2024-12-20T16:04:11Z",
  "updated_at": "2024-12-20T16:04:11Z"
}