XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API updates an existing member.

Request

{
   "Username":"NewPrivateApiUserName",
   "Name":"New Private Api User",
   "Password":"MyPassword",
   "Roles":[
      2,
      3
   ]
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/management/security/members/{memberId}

URI Parameters

Parameter Name Description Type Conditions
memberId Unique ID of the member Number

Request Body Description

Parameter Name Description Type Conditions
Roles Roles collection of the member. Array
Username User name of the member. String
Required: Yes
Name Name of the member. String
Password Password of the member. String
Required: Yes

Possible values for roles

Value Description
2 Private API role.
3 Management API role.

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

{
   "Id":13,
   "Username":"NewPrivateApiUserName",
   "Name":"New Private Api User",
   "Password":"MyPassword",
   "Roles":[
      {
         "Id":2,
         "Description":"Private"
      },
      {
         "Id":3,
         "Description":"Management"
      }
   ]
}

Response Body Description

Parameter Name Description Type
Id The unique ID of the member. Number
Username User name of the member. String
Name Name of the member. String
Password Password of the member. String
Roles[0..N].Id Unique ID of the member role. Number
Roles[0..N].Description Description of the member role. 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
400 (Bad Request) Given role ID collection is invalid.
404 (Not Found) Member not found.
409 (Conflict) There is an existing member with the same username.