Library

Create a fringe

post/library/fringes

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/library/fringes
  • Auth: HTTP bearer

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

namestring
descriptionstring nullable
calculationType'percent' | 'flat' | 'total'
ratenumber nullable
cutoffnumber nullable
fringeGroupIdsId[]
colorstring nullable

Example request

{
  "fringeGroupIds": [
    "txn_8f2a1c9e"
  ]
}

Response

The created fringe.

idstring required

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

namestring required
descriptionstring nullable required
calculationType'percent' | 'flat' | 'total' required
ratenumber nullable

Percentage for percent fringes, or the amount for flat and total fringes. For example, 7.65 means 7.65%.

cutoffnumber nullable
fringeGroupIdsId[] required
colorstring nullable required

Example response

{
  "id": "txn_8f2a1c9e",
  "fringeGroupIds": [
    "txn_8f2a1c9e"
  ]
}

Changes

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