Scope: inventory:rates.write https://api.alladdin.com/api/v2/price-lists/{priceListId}

Partially updates an existing price list (rate). Fields not present in the request body keep their current values.

Parameters

Path parameters

priceListId string required

Price List ID (24-char hex ObjectId)

Request body

object name string

Display name for the price list

description string | null

Optional description

Request

import requests

url = "https://api.alladdin.com/api/v2/price-lists/{priceListId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "name": "string",
    "description": "string"
}
response = requests.patch(url, headers=headers, json=payload)
print(response.json())

Responses

Response

{
  "id": "string"
}

Success responses

200 Price list updated application/json object id string

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Price list not found application/json 422 Validation error application/json

← PreviousCreate a price list →

Next →List price lists →