spaces

Invite users to space

Changed on

Invites one or more users to join a space. Only space admins can send invitations.

post/v1/spaces/{spaceId}/members/invite

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

spaceIdstring required
Example:123e4567-e89b-12d3-a456-426614174000

Space UUID to invite users to

Request body

Response

Users invited successfully

userIdnumber required
namestring required
spaceUuidstring required

Space UUID

role'ADMIN' | 'MEMBER' required
status'INVITED' | 'ACTIVE' | 'DECLINED' required
invitedBynumber nullable required

Changes

  • 20dfb0e32aa4Revision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the non-success response with the status

  • 081e1944f67cRevision changes
    • info

      for the path request parameter spaceId, the type was generalized from number to string

    • info

      response property items/spaceId deprecated

    • info

      added the required property / to the response with the status