Archive Channel
    • Dark
      Light
    • PDF

    Archive Channel

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/channels.archive

    Archive a channel.

    Changelog

    VersionDescription
    0.48.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Body parameters
    Example
    {
      "roomId": "ByehQjC44FwMeiLbX"
    }
    object
    roomId
    string Required

    The channel ID that you want to archive.

    Responses
    200

    OK

    Success
    {
      "success": true
    }
    object
    success
    boolean
    400

    Bad Request

    Channel is already archived
    {
      "success": false,
      "error": "The channel, add-room-websocket, is archived [error-room-archived]",
      "errorType": "error-room-archived"
    }
    object
    success
    boolean
    error
    string
    errorType
    string
    401

    Unauthorized

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

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.