Library

Update a rate pack

Update a workspace-owned rate pack. Other packs return 404 not_found.

patch/library/rate-packs/{packId}

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/library/rate-packs/{packId}
  • Auth: HTTP bearer

Path parameters

packIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Request body

namestring
descriptionstring nullable
categorystring
tagsstring[]

Response

The updated rate pack.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

slugstring required
namestring required
descriptionstring nullable
publisherstring nullable
categorystring required
tagsstring[]
visibility'public' | 'private' | 'shared' required

Who can access the pack. Public packs are available to every workspace; private packs belong to one workspace.

isOwnedboolean required

Whether the workspace owns the pack.

deprecatedboolean required

Whether the pack is deprecated. Deprecated packs cannot be newly enabled or added.

enabledboolean required

Whether the pack is enabled for the workspace.

enabledAtstring date-time nullable
enabledBystring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example response

{
  "id": "txn_8f2a1c9e",
  "enabledBy": "txn_8f2a1c9e",
  "latestVersion": {
    "id": "txn_8f2a1c9e"
  },
  "items": [
    {
      "id": "txn_8f2a1c9e",
      "rate": {
        "amount": 152900,
        "currency": "USD"
      },
      "version": {
        "id": "txn_8f2a1c9e"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.