Sign in
Library

Add a rate pack item

Add an item to a workspace-owned rate pack.

post/library/rate-packs/{packId}/items

Request

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

Path parameters

packIdstring required

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

Example:txn_8f2a1c9e

Headers

Idempotency-Keystring required

Unique request key, 16 to 255 characters. Retrying the same request returns the first response. Missing or invalid keys return 400 validation; reuse with a different body returns 409 idempotency_conflict.

Request body

titlestring required
unitstring required
descriptionstring
quantitynumber
multipliernumber
groupstring
agreementstring
localstring
effectiveDatestring date
labelsstring[]
displayTagsstring[]

Example request

{
  "rate": {
    "amount": 152900,
    "currency": "USD"
  }
}

Response

The created item.

idstring required

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

titlestring required
descriptionstring nullable
unitstring required
quantitynumber nullable
multipliernumber nullable
groupstring nullable
agreementstring nullable
localstring nullable
effectiveDatestring date nullable
labelsstring[]
displayTagsstring[]

Example response

{
  "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.