POST /users/me/spaces/{spaceId}/hide

Hide a specified space from the viewer (Me) list of spaces.

Note:

  • All contents for the space identified by spaceId is preserved and visible to the other parties.
  • The other parties will still see this Space in their list of direct/recent spaces.


Read Manage Space tutorial to lean how to un-hide a space.

Body Parameters

None.

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator

Authorization

isInviteCreatorByParams

Example Request

URL

POST https://spacesapis.avayacloud.com/api/users/me/spaces/{spaceId}/hide

Headers

Authorization: "jwt eyJhbGciOiJSgzI1NiIsIdfgdfgnR5cCI6IkpXVhJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHphNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZ1HZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJhRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Example Response

{
    "status": 4,
    "unread": false,
    "_id": "5f058c5682f82ea3fe050175",
    "targetId": "5f058c5682f82e7f05050174",
    "userId": "5ef9b678aa4a347af983c74c",
    "userType": "user",
    "lastAccess": "2020-07-17T08:52:42.942Z",
    "role": "admin",
    "targetType": "topic",
    "title": "Example name",
    "type": "group",
    "isPinned": false,
    "notification": false
}

Socket Event

The Spaces-Server would send the following Socket event to the user. So, other apps would hide this space from the user's Spaces list.

var message = {
    sender: {
        _id: '{senderId}',
        type: 'user',
        displayname: 'Sender display name'
    },
    category: 'topic.hidden',
    topicId: '{spaceId}'
};