Update Price List

PUT /price_lists/{priceListId}

Api key auth

Update a price list. Note: Default price list cannot be updated.

Path parameters

priceListId string(guid) Required

Unique ID of the price list

application/json

Body

price_list object
Hide price_list attribute Show price_list attribute object
- name string

Responses

200 application/json

Price List updated
Hide response attributes Show response attributes object
- id string(guid)
  
  System generated unique identifier. Don't include this in POST request body.
- name string
- created_at string(date-time)
- updated_at string(date-time)

PUT /price_lists/{priceListId}

curl \
 --request PUT 'https://stg.getfoundation.com/api/external/v1/price_lists/{priceListId}' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"price_list":{"name":"string"}}'

Request examples

{
  "price_list": {
    "name": "string"
  }
}

Response examples (200)

{
  "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "name": "string",
  "created_at": "2025-05-04T09:42:00Z",
  "updated_at": "2025-05-04T09:42:00Z"
}