Jump to

• Request
• Response
• Examples

Update a space

put

/swm/rs/v1/spaces/{spaceId}

Update the name, description and/or access level for an existing space.

Space name can not be blank and must be unique for the API user.

The API user must have created (own) the space

Request

Supported Media Types

• application/json

Path Parameters

• spaceId: string
  The ID of the space resource

Body ()

{
"spaceName":"string", - New name for the space (optional)
"spaceDescription":"string", - New description for the space (optional)
"accessLevel":"number" - 0 (Private), 1 (Shared), or 2 (Group)
}

Root Schema : schema

Type: string

Back to Top

Response

Supported Media Types

• application/json; charset=UTF-8

200 Response

space resource updated

404 Response

space resource not found

Back to Top

Examples

Sample Request:

       {
        "spaceName":"Updated Space Name",
        "spaceDescription":"Updated space description",
        "accessLevel":"1"
       }    

Sample Response:

       {"response":{"code":"200.1","developerMessage":"space resource updated"},
        "spaceName":"Updated Space Name"},
        "spaceId":"rpCcZTzUdDbVAmRjCy2BFCOO"},
        "spaceDescription":"Updated space description"}    

Possible Error Codes:

       {
          "code":"403.2","developerMessage":"not space owner",
          "code":"409.0","developerMessage":"space resource already exists",
          "code":"403.3","developerMessage":"space still has members and cannot be private",
          "code":"404.0","developerMessage":"space resource not found"
       }    

Back to Top