API Reference
Start typing to search…

Claim an Offer

post https://neon-loyalty-qa.spika.com/loyalty/v1//offers//actions/claim

The offer must be UNLOCKED to be claimed.
In the case of PERSONAL offers when more than one instance of the offer is unlocked,
the specific instance has to be specified as well.

Path Params
string
required

The name of the space (database) assigned to you.

string
required

One of:

  • The Entity's internal Entity Id
  • The Entity's name
  • The Entity's business Id, prefixed with $
Query Params
string

The Dimensions under which the calling application operates.
Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

Body Params
string

Accepts Member Lookup Id

string

Only used for unlocked PERSONAL offers, when more than one instance has been unlocked.

json

Optional Json data to be stored with the claim and passed to triggers and accessed through IN.data..

Response

Updated 5 months ago

Did this page help you?
Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?