Set a group channel alias

Set the alias that a specified user sees for a group channel. If the user receives a push notification while offline, the alias is used as the push title when available. Otherwise, the default group name is used.

Request

POST: https://Base URL/v4/group-channel/alias/set

Rate limit: 100 per second

Signature: Required. See API request signature.

Request body

Content type: application/json

Parameter	Type	Required	Description
channelId	String	Yes	Group channel ID.
userId	String	Yes	User ID of the group member.
alias	String	Yes	Alias (remark name) for the group. Maximum: 64 characters. If an alias already exists, this value replaces it.

Request example

HTTP

POST /v4/group-channel/alias/set HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
   "channelId": "456",
   "userId": "123",
   "alias": "Happy Parents Group"
}

Response

Field	Type	Description
code	Number	Return code. 0 indicates success. See Status codes.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
   "code": 0
}