MISSINdevelopersLog in

API reference

CreateIncentive

Create an incentive with its rules: what a customer earns and when. Write access, incentives toolset, MCP tool create_incentive.

Access: Write

Variables

VariableTypeRequiredAcceptsDescription
inputCreateIncentiveInput!yesInput object, below

Input types

CreateIncentiveInput

FieldTypeRequiredAcceptsDescription
audienceStringnoOne of NEW, RETURNINGNEW | RETURNING, or null for everyone — the same wildcard tier uses.
descriptionStringnoat most 500 characters
formIdUUIDno
limitCountIntno32-bit integer. 1 to 100Per-customer claim cap. Set it together with limitPeriod, or leave both unset.
limitPeriodStringnoOne of DAY, WEEK, MONTH, EVER, ORDERDAY | WEEK | MONTH | EVER: rolling windows.
nameString!yes1 to 120 characters
rulesJSONnoAny JSON value. at most 3 items
tierStringnoOne of quick, enhanced

Call it

bash
curl https://api.missin.co.uk/graphql/v1 \
  -H "Authorization: Bearer $MISSIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operationName":"CreateIncentive","variables":{"input":{"name":"Example"}},"extensions":{"persistedQuery":{"version":1,"sha256Hash":"ed6452ddf749874da2485439dc6fecdee98122cea2b282adfe198175b34ab2d1"}}}'

Document

graphql
mutation CreateIncentive($input: CreateIncentiveInput!) { __typename createIncentive(input: $input) { __typename incentiveId userErrors { __typename code field message } } }

For AI agents: a markdown index of this site is at /llms.txt, and every page is available as markdown by adding .md to its URL.