Library

Add an incentive to a project

Add the published version of an available incentive program. Unpublished or deprecated incentives return 400 validation.

post/projects/{projectId}/library/incentives

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/projects/{projectId}/library/incentives
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Project ID or slug.

Request body

programIdstring required

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

versionIdstring

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

Example request

{
  "programId": "txn_8f2a1c9e",
  "versionId": "txn_8f2a1c9e"
}

Response

The existing project incentive.

idstring required

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

namestring required
jurisdictionstring nullable
incentiveTypestring nullable
sourceType'workspace' | 'saturation' required

Where the project Library item came from.

sourceIdstring

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

sourceIncentiveVersionIdstring

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

isAppliedboolean required

Whether the incentive is currently applied to the project's budget.

accountNumberstring nullable

Budget account number for the incentive.

ratenumber nullable

Credit rate as a percentage. For example, 30 means 30%.

appliedCreditCapinteger nullable

Maximum credit in minor currency units, or null for no limit.

discountPercentnumber nullable

Broker fee deducted from the credit, as a percentage.

tierOverrideKeystring nullable

Selected incentive tier, or null to choose the tier from qualified spend.

Example response

{
  "id": "txn_8f2a1c9e",
  "sourceId": "txn_8f2a1c9e",
  "sourceIncentiveVersionId": "txn_8f2a1c9e",
  "source": {
    "id": "txn_8f2a1c9e",
    "currentVersion": {
      "id": "txn_8f2a1c9e"
    }
  }
}

Changes

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