Developer Portal
Last Updated: February 19, 2016
Updating an existing metadata
This API provides a way to update an existing loyalty user metadata.
Request
{
"LoyaltyUserId": 5,
"Key": "2a1c5efa-915b-4e96-97b2-ada1a8d58a56",
"Value": "New Value!"
}
| HTTP Method | Resource URI |
|---|---|
| PUT | https://{tenantName}.api.xomni.com/private/pii/loyaltymetadata |
Request Body Description
| Parameter Name | Description | Type | Conditions |
|---|---|---|---|
| LoyaltyUserId | The unique ID of the loyalty user. | Number | |
| Key | Key of the loyalty user metadata. | String |
Required
|
| Value | Value of the loyalty user metadata. | String |
Required
|
Request Headers
| Header Field Name | Description |
|---|---|
| Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
| Accept |
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
|
| Authorization |
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
|
Response
{
"LoyaltyUserId": 5,
"Key": "2a1c5efa-915b-4e96-97b2-ada1a8d58a56",
"Value": "New Value!"
}
Response Body Description
| Parameter Name | Description | Type |
|---|---|---|
| LoyaltyUserId | The unique ID of the loyalty user. | Number |
| Key | Key of the loyalty user metadata. | String |
| Value | Value of the loyalty user metadata. | String |
Response Headers
| Header Field Name | Description |
|---|---|
| Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
Status Codes
A successful operation returns status code 200 (OK) for PUT operations. Possible response status codes are as listed below:
| Status Code | Description |
|---|---|
| 404 (Not Found) | No loyalty user metadata has been found for the given key. |
| 404 (Not Found) | No loyalty user has been found for the given loyalty user ID. |