Update Announcement

POST api/v1/channel/announcement/update

  • Note: It is for setting announcements for the group chat. Only Admin of the group chat is allowed to do this.

  • 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

announcement

String

Content of the announcement

pinAnnouncement

boolean

Whether it should be sticked on top. True-yes;false-no

  • Request Example

curl POST 'https://api.relationlabs.ai/api/v1/channel/announcement/update' \
--header 'ApiKey: <ApiKey>' \
--header 'Authorization: bearer eyJhbGciOiJFUzI1NiJ9.eyJqdGkiOiI0MzdiN2EzZDEwMGY0ODVkOWVhMWUzZmZlOWE1NmEyZSIsImlzcyI6InJlbGF0aW9ubGFicy5haSIsImlhdCI6MTY2NTIxNTUzNSwic3ViIjoiZGhreXEtc3FhYWEtYWFhYWotc2d6M3EtY2FpIiwiZXhwIjoxNjY1ODIwMzM1fQ.rj7KKuIcgmvaIwZ63YHnXQ4jvvI-eR2Wo7k3YEyzMuxo8j5ezCowKDpcW0u9zIuHPFqwD0-1XPWdPLR1d1HLFw' \
--header 'Content-Type: application/json' \
--data-raw '{

    "channelUuid":"4f326124812c41448bc587bf6b2eaf42",
    "announcement":"1234",
    "pinAnnouncement":true
}'
  • Response Parameters

Field
Type
Remarks

code

String

the Return Code

desc

String

the Return Message

  • Response Body

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

code
desc
Remarks

0

success

the flag for a successful request

13106

Not the owner of this club

Not the owner of this club

13107

Not the admin of this channel

Not the Admin of the current group chat

Last updated