Update an existing invitation.

URL Parameters

NameDescriptionLocationRequiredDefault Value
inviteIdUnique identifier of the invite.pathYes

Body Parameters

NameDescriptionJSON typeRequiredDefault Value
_idUnique identifier of the invite.stringYes
topicIdUnique identifier of the space.stringYes
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)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

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator

Authorization

isInviteCreatorByParams

Example Request

URL

POST https://spacesapis.zang.io/api/spaces/invites/{inviteId}

Headers

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

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Body

{ 
  "data": {
    "_id": "5759bfa17f0a984605351e77",
    "topicId": "5759abb04dc8127525068ab5",
    "startDateTime": "2016-06-09T17:47:28.003Z",
    "endDateTime": "2016-06-09T18:47:28.003Z",
    "invitees": [
      {
          "inviteeType": "userId",
          "invitee": "5697decc283a4708c4f78bf8",
          "role": "member"
      },
      {
          "inviteeType": "email",
          "invitee": "harryh@esna.com",
          "role": "member"
      }              
    ],
    "created": "2016-06-09T17:47:28.348Z"
  },
  "informChannel" :"client",
  "inviteMode" :"meet"
}

Example Response

{
  "data": [
    {
      "_id": "59039e47e2cda45e3bbbfc80",
      "topicId": "59039e47e2cda45e3bbbfc7f",
      "startDateTime": "2017-04-28T19:55:50.950Z",
      "endDateTime": "2017-04-28T20:55:50.950Z",
      "invitees": [
        {
          "inviteeType": "email",
          "invitee": "han42@avaya.com",
          "role": "member"
        }
      ],
      "created": "2017-04-28T19:55:51.102Z"
    }
  ],
  "inviteContent": {
    "text": "Hi, You have been invited to join invite + new space on Avaya Spaces!\nFollow the link to join the meeting:  https://spaces.zang.io/spaces/invites/59039e47e2cda45e3bbbfc80/meet\n Avaya Spaces Team",
    "html": "

Hi, You have been invited to join invite + new space on Avaya Spaces!

Follow the link to join the meeting:  https://spaces.zang.io/spaces/invites/59039e47e2cda45e3bbbfc80/meet

Avaya Spaces Team

" } }