Setting the loyalty level of a user

Contents

• Overview
• Version-specific information
• Permissions and Authentication
• Headers
• HTTP Parameters
• Sample request
• Sample response
• Possible error responses

Overview

• Call name: alter-user-loyalty-level
• Endpoint URL: https://api0.spaaza.com/auth/alter-user-loyalty-level
• Request methods: PUT
• Request Content-Type: application/json or application/x-www-form-urlencoded*
• Response Content-Type: application/json
• Auth required: yes

* In the case of a JSON payload (application/json) all parameters are top-level elements.

This endpoint allows changing the loyalty level of a user in the Spaaza system. The new loyalty level must be associated with the same chain as the user’s MyPrice app. The change can be performed either by an admin user with write access or through privileged authentication.

Version-specific information

The following version-specific changes apply to this endpoint. See the versioning page for more details.

Permissions and Authentication

This API call requires one of the following authentication methods:

• Admin authentication: the performing user needs to be logged in and have write access to the chain to which the user is connected.
• Privileged authentication: the use of privileged authentication is permitted for this endpoint. For privileged authentication, the X-Spaaza-MyPrice-App-Hostname header must be passed in the request.

Headers

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

HTTP Parameters

The following HTTP parameters can be passed to the API:

Sample request

{
    "user_id": 4232324,
    "loyalty_level_id": 123
}

Or using member number:

{
    "member_number": "20000000001",
    "loyalty_level_id": 123
}

Sample response

Returns an OK code and information about the updated loyalty level:

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "user_loyalty_level_progress": {
            "loyalty_level": {
                "id": 123,
                "campaign_id": 123123,
                "name": "VIP",
                "description": "VIP level in the Loyalty Programme",
                "automated_level_logic": 0
            },
            "created_datetime": "2025-01-15T10:30:00+00:00",
            "notes": "Manual level change"
        },
        "result_type": "alter-user-loyalty-level"
    }
}

Possible error responses

The following represents a list of possible error responses for the alter-user-loyalty-level endpoint: