Altering a user

Contents

• Overview
• Version-specific information
• Permissions and Authentication
• Headers
• HTTP Parameters
  • User identification parameters
  • Other parameters
  • Caveat - updating users with dummy email addresses
• Sample requests

Overview

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

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

This API call modifies an existing user account.

Version-specific information

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

Permissions and Authentication

• User authentication: a session generated by an end-user login.
• Admin authentication: the performing user needs to be logged in and have write access to the chain with which the user account is associated.
• Privileged authentication: the use of privileged authentication is permitted for this endpoint.

Headers

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

HTTP Parameters

In this section the parameters which can be passed to the API are divided into “User identification parameters,” i.e. those required in order to identify the user account to be altered, and “Other parameters,” i.e. general parameters which can be altered.

User identification parameters

When using user authentication the user account to be altered is already identified by the login session. However, when using admin or privileged authentication, one of five identification parameters must be passed in order to identify which user account is to be altered:

• user_id
• authentication_point_identifier
• member_number
• username
• referral_code

Critically, whilst the user_id parameter is immutable, it is possible to alter the other three user identification parameters if they are passed and are not being used to identify the user account.

For example, if the user_id and username parameters are passed in a call, and the user_id parameter is used to identify the user account, the username (email address) associated with the account will be altered if the username parameter is different than the account’s current username.

Note also that if parameters are in use by two or more different existing user accounts, an error will be returned. For example, if both user_id and username parameters are passed in a call, the user_id already belongs to one existing account, and the username to another existing account, it is not possible to ascertain which account is to be altered, so an error will be returned.

The four user identification parameters are shown below:

Additionally, the following parameter is also required in the case of admin authentication in order to identify which Spaaza chain the user account is tied to:

Other parameters

This section lists the other parameters which are properties of a user account, and which can be altered, but are not used to identify the account.

Note that, in order to remove values such as ‘address_housenumber_extension’ from a user record, it is necessary to send their parameters as empty values.

Caveat - updating users with dummy email addresses

It is possible to create user accounts without supplying a username (email address) value. Please see the relevant add-user section on creating a user with a dummy username for more details.

When updating a user with a dummy email address, the username parameter can be set to a value “null” or an empty string. In this case, the username will not be changed to true null, but to a dummy email address.

It is not possible to update the member_number parameter in the same call as the username parameter is passed as a “null” value or empty string. This is because the user’s member_number is used to create a new dummy email address.

Sample requests

The endpoint returns an OK code and a JSON for the user. A sample is shown below:

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "user_info": {
            "address_housenumber": "46",
            "address_housenumber_extension": "B",
            "address_latitude": null,
            "address_line_2": "Apartment #416",
            "address_line_3": null,
            "address_longitude": null,
            "address_postalcode": "1015CB",
            "address_regionstate": "Any State",
            "address_streetname": "Any Street",
            "address_towncity": "Amsterdam",
            "authentication_point": null,
            "authentication_point_identifier": "99911166488945",
            "auxiliary_identifier": null,
            "average_basket_value": "0.00",
            "birthday": "1981-07-21",
            "business_group": null,
            "country_code": "NL",
            "created_date": "2024-01-31 15:15:43",
            "days_since_last_purchase": null,
            "entity_code": {
                "code": "3935159",
                "type": "regular"
            },
            "favorite_store": null,
            "first_name": "Josephine",
            "frequency": 1,
            "gender": "M",
            "id": 3935159,
            "is_employee": false,
            "is_influencer": false,
            "language": null,
            "last_modified_date": "2024-01-31 15:15:44",
            "last_name": "Bloggs",
            "loyalty_status": {
                "date_reached": null,
                "last_review_date": "2024-01-31T15:15:43+00:00",
                "loyalty_level_id": null,
                "monetary_balance_current": 0,
                "next_review_date": null,
                "points_balance_current": 5,
                "points_to_proceed_next_level": null,
                "points_to_remain_current_level": null
            },
            "mailing_list": {
                "mailing_list_sub_offered": false,
                "mailing_list_subscribed": true,
                "printed_mailing_list_subscribed": true
            },
            "member_number": "3935159",
            "monetary": 2,
            "number_of_purchases": 0,
            "obfuscated": false,
            "offline_shopper": false,
            "online_shopper": false,
            "opt_in_programme": {
                "join_date": "2024-01-31T15:15:43+00:00",
                "programme_opted_in": true
            },
            "opt_in_secondary": false,
            "overall": 3,
            "phone_number": "+31655222555",
            "points_wallet_total": 5,
            "push_notification_subscription": {
                "subscribed": false,
                "subscriptions": []
            },
            "recency": 5,
            "referral_channel": null,
            "referral_code": "gzo85d",
            "referred": true,
            "referring_user": {
                "authentication_point_identifier": null,
                "campaign_id": 2539,
                "id": 3930871,
                "referral_channel": null,
                "referral_code": "4t38p9"
            },
            "registered": true,
            "signup_channel": null,
            "signup_store": {
                "signup_store_id": 1383,
                "signup_store_name": "MOCO Museum store"
            },
            "stores": "",
            "total_cashback_balance": 0,
            "user_id": 3935159,
            "user_type": "registered",
            "username": "somedude0.11073246009398896@spaaza.com"
        },
        "result_type": "alter-user"
    }
}