Interact with campaign

An example response for successful interaction with any campaign

{
  "result": {
    "code": 1,
    "status": "ok"
  },
  "results": {
    "success": true,
    "result_type": "interact-campaign"
  }
}

Overview

• Call name: interaction-campaign
• Endpoint URL: https://api0.spaaza.com/interact-campaign
• Request methods: GET
• Response Content-Type: application/json
• Auth required: yes

The interact-campaign API endpoint carries out a configured campaign interaction for an end-user (customer). This might result in one of many possible actions, such as the issuing of points or vouchers for a campaign.

The campaign logic itself dictates the result of the interaction. The role of the interact-campaign endpoint is not to describe this result, but only to respond with whether the interaction was successful or not.

Note that, in the case a reward has already been redeemed, a 200 OK response is sent along with a warning campaign_fully_redeemed.

Permissions and authentication

This API call requires a valid Spaaza session. The session can be as follows:

• User authentication: a session generated by an end-user login.
• Admin authentication: the performing user needs to be logged in and have read access to the entity (business or chain) to which the user is connected.
• Privileged authentication: the use of privileged authentication is permitted for this endpoint.

HTTP Parameters

The following HTTP parameters can be passed to the API:

Headers

The following headers can/must be passed to the API call:

Possible error responses

The following represents a list of possible error responses for the interact-campaign endpoint: