change-room-archive-state.md

Change Room Archive State

HTTP Method	URL	Requires Auth
POST	/api/v1/rooms.changeArchivationState	yes

Body Parameters

Key	Example Value	Description
rid*	JZ8Y2dLfYhsg323R	The room ID.
action	archive	The room will be archived or unarchived.

Example Call

curl -L -X POST 'http://localhost:3000/api/v1/rooms.changeArchivationState' \
-H 'X-User-Id: d26x6zSkaPSe5gCyy' \
-H 'X-Auth-Token: Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92' \
-H 'Content-Type: application/json' \
--data-raw '{
    "rid": "iu7jtPAhvEeAS5tNq",
    "action": "archive"
}'

Example Response

Success

{
    "success": true
}

Error

Any of the following errors can occur:

• Authorization: Requires an authentication token for the request to be made.
• Invalid Room: Occurs when the given rid is invalid.

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

{
    "success": false,
    "error": "unauthorized"
}

{% endtab %}

{% tab title="Invalid Room ID" %}

{
    "success": false,
    "error": "Invalid room [error-invalid-room]",
    "errorType": "error-invalid-room",
    "details": {
        "method": "unarchiveRoom"
    }
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
3.3.0	Added