archive-channel.md

Archive Channel

Archives a channel.

HTTP Method	URL	Requires Auth
POST	/api/v1/channels.archive	yes

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The channel ID that you want to archive.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     https://localhost:3000/api/v1/channels.archive \
     -d '{ 
          "roomId": "ByehQjC44FwMeiLbX" }'

Example Response

Success

{
    "success": true
}

Error

Any of the following errors can occur:

• Authorization: Requires an authentication token for the request to be made.
• Room Archived: This occurs when the channel is already archived.

{% tabs %} {% tab title="Authorization" %}

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

{% endtab %}

{% tab title="Room Archived" %}

{
    "success": false,
    "error": "The channel, add-room-websocket, is archived [error-room-archived]",
    "errorType": "error-room-archived"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
0.48.0	Added