Jump to

• Request
• Response
• Examples

Create an invitation

post

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

Creates a space invitation token, and changes the space access level to group if it was private before, otherwise the access level is not changed.

The API user must be creator of space.

The response accessLevel is the resulting access-level for the space:

• 1 - Shared
• 2 - Group

Request

Supported Media Types

• application/json

Path Parameters

• spaceId: string
  The ID of the space resource

Back to Top

Response

Supported Media Types

• application/json; charset=UTF-8

200 Response

successful operation

Body ()

Root Schema : JSONObject

Type: object

201 Response

invitation resource created

400 Response

invalid email address parameter

403 Response

not space owner

Back to Top

Examples

Sample Request:

       POST swm/rs/v1/spaces/Topo3CqoDPchgkK1mMxEgubY/invitations    

Sample Response:

       {"response":{"code":"201.0","developerMessage":"invitation resource created"},
        "invitationToken":"AvPq9IlQWnno2GLTJys0igeH",
        "accessLevel":"2"}    

Possible Error Codes:

       {
          "code":"403.2","developerMessage":"not space owner"
       }    

Back to Top