Hide

  • Note: This is to hide the current group chat. It will not be displyed in the group chat list until a new message is received by the group.

  • Header

Field
Type
Remarks

ApiKey

String

ApiKey acquired from the admin

Authorization

String

Bearer ${unifiedAuthToken} , in which the unifiedAuthToken is returned by /api/v1/auth

  • Request Parameters

Field
Type
Remarks

channelUuid

String

the uuid of the group chat

  • Request Example

curl POST 'https://api.relationlabs.ai/api/v1/userChannels/pin' \
--header 'ApiKey: <ApiKey>' \
--header 'Authorization: bearer eyJhbGc1iOiJFUzI1NiJ9.eyJqdGkiOiI0MzdiN2EzZDEwMGY0ODVkOWVhM1WUzZmZlOWE1NmEyZSIsImlzcyI6InJlbGF0aW9ubGFicy5haSIsImlhdCI6MTY2NTIxNTUzNSwic3ViIjoiZGhreXEtc3FhYWEtYWFhYWotc2d6M3EtY2FpIiwiZXhwIjox1NjY1ODIwMzM1fQ.rj7KKuIcgmvaIwZ63YHnXQ4jvvI-eR2W1o7k3YEyzMuxo8j5ezCowKDpcW0u9zIuHPFqwD0-1XPWdPLR1d1HLFw' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channelUuid":"e54d938caa09498fa1a09f7cfe4e21f4"
}'
  • Response Parameters

Field
Type
Remarks

code

String

the Return Code

desc

String

the Return Message

data

Object

the data

  • Response Body

{
    "code": "0",
    "desc": "success",
    "data": null
}
  • Return Code

code
desc
Remarks

0

success

the flag for a successful request

Last updated