POST /spaces/invite

Creates a new space and a new invitation(s). The user that calls this API will be an admin in the space.

URL Parameters

None

Body Parameters

NameDescriptionJSON typeRequiredDefault Value
topicObject describing the space to be created.
  • id: (string) should be null.
  • title: (string) name of the new space.
  • description: (string, optional) description of the new space.
  • type: (string) 'group'.
ObjectYes
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')
ObjectNo
startDateTimeUTC timestamp space start time.stringNo
endDateTimeUTC timestamp space end time.stringNo
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
inviteMode'invite' (invite link to join space), 'meet' (invite to join and meet in fullscreen video/audio session)stringNojoin
inviteContentLanguageThe language code in the response field "inviteContent". Without this value, system uses the sender's primary language. If the input language is not supported by spaces, spaces apply default language code 'en-US'.stringNoserver

HTTP Headers

HTTP HeaderValueDescriptionRequired
X-Avaya-Act-As[user’s email address]This allows service type of application to create a new space using another user’s email as the owner of the new space. This is only supported with the following conditions:
  1. The request has valid service app JWT.
  2. The service app must be enabled with the “spaces.create.actas” scope.
  3. The user’s email address must have the same domain as the service account’s email domain.
After the space is created, the service app can use the following API to become the admin of this new space so that it can manage this space:		No

Authorization

PERM_TOPIC_CREATE

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator, ServiceAppAuthenticator

Example Request

URL

For Production: POST https://spacesapis.avayacloud.com/api/spaces/invite
For Staging: POST https://loganstagingapis.esna.com/api/spaces/invite

Headers

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

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Or

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

Body

{
  "topic": {
    "id": null,
    "title": "invite + new space",
    "description": "",
    "type": "group"
  },
  "invitees": [{
    "inviteeType": "email",
    "invitee": "example.user@avaya.com",
    "role": "member"
  }],
  "startDateTime": "2017-04-28T19:55:50.950Z",
  "endDateTime": "2017-04-28T20:55:50.950Z",
  "informChannel": "server"
}

Example Response

{
  "data": [{
    "topicId": "59039e47e2cda45e3bbbfc7f",
    "startDateTime": "2017-04-28T19:55:50.950Z",
    "endDateTime": "2017-04-28T20:55:50.950Z",
    "_id": "59039e47e2cda45e3bbbfc80",
    "invitees": [{
      "inviteeType": "email",
      "invitee": "example.user@avaya.com",
      "role": "member"
    }],
    "created": "2017-04-28T19:55:51.102Z"
  }]
}