Update Company Price Lists
Attach and/or detach price lists for a company.
Use this to synchronize commercial price-list assignments independently of the company’s general details.
Behaviour
Provide at least one non-empty list; a price-list id cannot appear in both lists.
Every id being attached must exist (404 price_list_not_found otherwise, naming the unknown ids in details); ids being detached are not checked.
Returns the refreshed price-list summaries.
Requires the companies:write scope.
API key sent as a bearer token (mk_live_… / mk_test_…).
^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Data schema used by Update Company Price Lists (POST /v1/companies/{companyId}/price-lists). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.
Successful response.
Invalid request data.
Missing or invalid API key.
The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).
Resource not found.
The API key exceeded its request rate (rate_limit_exceeded) or its monthly quota (quota_exceeded). Both carry Retry-After; the RateLimit-* headers accompany rate_limit_exceeded only, since a spent quota says nothing about the bucket.
Internal server error.
POST /v1/companies/{companyId}/price-lists HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"priceListIdsToAttach": [
"text"
],
"priceListIdsToDelete": [
"text"
]
}{
"data": {
"companyId": "COMP-123e4567-e89b-12d3-a456-426614174000",
"priceLists": [
{
"priceListId": "text",
"priceListName": "text",
"status": "text"
}
]
}
}Last updated
Was this helpful?