Update Nickname
Overview
This request is used to update the nickname of a participant in a chat interaction.
| Request URL | /api/v2/chats/{chatId} |
|---|---|
| HTTP Method | POST |
| HTTP Header | Content-Type |
| Value | application/json |
Parameters
| Parameter Name | Sample Value | Description | Required/Optional |
|---|---|---|---|
| operationName | "UpdateUserNickname" | To identify the operation to be performed at this URL | Required |
| userId | "007553863DC30029" | user ID | Required |
| secureKey | "8b31761b2154884c" | secure key | Required |
| alias | "117" | host alias | Required |
| tenantName | "Environment" | tenant name | Required |
| nickname | "New Nickname" | New nickname for the user | Required |
Example
Request
{
"operationName" : "UpdateUserNickname",
"alias" : "117",
"secureKey" : "8b31761b2154884c",
"userId" : "007553863DC30029",
"tenantName": "Environment",
"nickname" : "New Nickname"
}
Response
{
"statusCode":0,
"alias":"117",
"secureKey":"cf8f2f9e1ea85eba",
"userId":"0075539F6B140000",
"tenantName": "Environment"
}
This page was last edited on September 11, 2014, at 14:16.
Comments or questions about this documentation? Contact us for support!
