Set Channel Announcement

Set Channel Announcement

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/v1/channels.setAnnouncement

Set an announcement for the channel.

Version	Description
0.63.0	Added

Header parameters

X-User-Id

stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

X-Auth-Token

stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

Body parameters

Success

{
  "roomId": "WDuJLFkjwk6L7LdFC",
  "announcement": "Test out everything"
}

object

roomId

string Required

The channel's id

announcement

string Required

The announcement to set for the channel.

Responses

200

Example

{
  "announcement": "Test out everything",
  "success": true
}

object

announcement

string

success

boolean

401

Unauthorized

Authorization Error

{
  "status": "error",
  "message": "You must be logged in to do this."
}

object

status

string

message

string

Was this article helpful?