XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API provides a way to create a new loyalty user metadata.

Request

{
     "LoyaltyUserId": 5,
     "Key": "2a1c5efa-915b-4e96-97b2-ada1a8d58a56",
     "Value": "a2c34a01-0234-4c76-a22b-5b3e215530a1"
}
HTTP Method Resource URI
POST 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.
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
     "LoyaltyUserId": 5,
     "Key": "2a1c5efa-915b-4e96-97b2-ada1a8d58a56",
     "Value": "a2c34a01-0234-4c76-a22b-5b3e215530a1"
}

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 POST operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) No loyalty user has been found for the given loyalty user id.
409 (Conflict) Given loyalty user metadata already exist.