POST /spaces/{spaceId}/invite

Create a new invite for an existing space. Invitees will be added to the list of members for the space.

URL Parameters

NameDescriptionLocationRequiredDefault Value
spaceIdUnique identifier of the space.pathYes

Body Parameters

NameDescriptionJSON typeRequiredDefault Value
startDateTimeUTC timestamp space start time.stringNo
endDateTimeUTC timestamp space end time.stringNo
inviteesArray of objects describing the members to invite.
  • inviteeType: (string) 'email' (invitee is not a spaces user) or 'userid' (invitee is a user)
  • invitee: (string) the email address (if inviteeType is email) or the userid (if inviteeType is user)
  • role: (string) permission level in space: ('admin', 'member' (default), 'guest')
ObjectYes
informChannel'server' (Spaces will email the invites), 'client' (Spaces will return the html of the invites for the user to send), 'outlook' (Spaces will return special html compatible with Microsoft Outlook)stringNoserver
inviteContentLanguageThe language of invite content in response property inviteContent. If the input language is not supported by spaces, language code 'en-US' is used.stringNoSending user's language setting

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator

Authorization

PERM_TOPIC_UPDATE

Example Request

URL

POST https://spacesapis.avayacloud.com/api/spaces/{spaceId}/invite

Headers

Authorization: "jwt eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Body

{
   "invitees":[
      {
         "inviteeType":"userId",
         "invitee":"5ef48c5faa4a347af91771c3",
         "role":"member"
      }
   ]
}

Example Response

{
   "data":[
      {
         "inviteMode":"join",
         "_id":"5f118ff422434f044f4496f7",
         "invitees":[
            {
               "inviteeType":"userId",
               "invitee":"5ef48c5faa4a347af91771c3",
               "role":"member"
            }
         ],
         "topicId":"5f118d7c10ea162d7e8eac88",
         "created":"2020-07-17T11:48:04.456Z"
      }
   ]
}