XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The tag management systems provides APIs to update a particular tag in backend. Using this API, you can update tag name and description of a particular tag.

Request

{
    "Id":15,
    "Name":"SampleTagName",
    "Description":"Sample Tag Description"
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/private/catalog/tag

Request Body Description

Parameter Name Description Type Conditions
Id The unique ID of the tag. Number
Name The name of the tag. String
Required
Description The description of the tag. String

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

{
    "Id":15,
    "Name":"SampleTagName",
    "Description":"Sample Tag Description",
    "TagMetadata":[
       {
           "Key":"Key0",
           "Value":"83b5ce23-827e-404b-81a7-03fc5d066e0a",
       },
       {
           "Key":"Key0",
           "Value":"f1777570-a324-4418-8d68-2bf57b26783f",
       },
       {
           "Key":"Key0",
           "Value":"8a6c0d95-63b1-41bd-a607-26d330ddeaca",
       },
       {
           "Key":"Key0",
           "Value":"28ed938b-e104-47d8-bdbb-dd05d7627405",
       },
       {
           "Key":"Key0",
           "Value":"8d96d70b-be02-47cc-8079-986a9bd4f56f",
       }
    ]
}

Response Body Description

Parameter Name Description Type
Id The unique ID of the tag. Number
Name The name of the tag. String
Description The description of the tag. String
TagMetadata[0..N].Key The key for the metadata. String
TagMetadata[0..N].Value The value of the 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 tag found for given tag id.
409 (Conflict) Given tag name already exists.