Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »


Show an Incentive Pool

GET /companies/:id/incentives/pools/:pool_id

Issue an Incentive Code

POST /companies/:id/incentives/pools/:pool_id/issuances

Request body

  "external_issuee_id": "312",
  "code": "aabb-ccdd",
  "referring_application": "system",
  "referring_application_ref_id" : "1234"

Request Elements

Data ElementRequiredDescription


NoUnique external issuee id.

If provided, a specific code is issued.


Only in pools requiring a campaign_registration.Application issuing the code.


Only in pools requiring a campaign_registration.Application reference id.


It returns an issuance entity if there was an available code.

An HTTP error code 422 is returned if there are not enough available codes to issue

Code Issuance

The same code is issued when using the same issuee_id. An issuance entity is created after each successful issuance request.

  • No labels