iR Engine API
invite
/invite
1 min
code examples curl location globoff request patch '/invite?filter={%22id%22%3a%22string%3cuuid%3e%22%2c%22spawndetails%22%3a{}%2c%22userid%22%3a%22string%3cuuid%3e%22%2c%22invitetype%22%3a%22string%3cfriend%20%7c%20channel%20%7c%20location%20%7c%20instance%20%7c%20new user%3e%22%2c%22user%22%3a{%22id%22%3a%22string%3cuuid%3e%22%2c%22name%22%3a%22string%22%2c%22ageverified%22%3afalse%2c%22isguest%22%3afalse%2c%22lastlogin%22%3a{%22id%22%3a%22string%3cuuid%3e%22%2c%22useragent%22%3a%22string%22%2c%22ipaddress%22%3a%22string%22%2c%22userid%22%3a%22string%3cuuid%3e%22%2c%22identityproviderid%22%3a%22string%3cuuid%3e%22%2c%22createdat%22%3a%22string%3cdate time%3e%22}%2c%22createdat%22%3a%22string%3cdate time%3e%22%2c%22updatedat%22%3a%22string%3cdate time%3e%22}%2c%22invitee%22%3a{%22id%22%3a%22string%3cuuid%3e%22%2c%22name%22%3a%22string%22%2c%22ageverified%22%3afalse%2c%22isguest%22%3afalse%2c%22lastlogin%22%3a{%22id%22%3a%22string%3cuuid%3e%22%2c%22useragent%22%3a%22string%22%2c%22ipaddress%22%3a%22string%22%2c%22userid%22%3a%22string%3cuuid%3e%22%2c%22identityproviderid%22%3a%22string%3cuuid%3e%22%2c%22createdat%22%3a%22string%3cdate time%3e%22}%2c%22createdat%22%3a%22string%3cdate time%3e%22%2c%22updatedat%22%3a%22string%3cdate time%3e%22}%2c%22createdat%22%3a%22string%3cdate time%3e%22%2c%22updatedat%22%3a%22string%3cdate time%3e%22}' \\ \ header 'accept application/json' \\ \ header 'content type application/json' \\ \ data '{"body" {"id" "string\<uuid>","spawndetails" {},"userid" "string\<uuid>","invitetype" "string\<friend | channel | location | instance | new user>","user" {"id" "string\<uuid>","name" "string","ageverified"\ false,"isguest"\ false,"lastlogin" {"id" "string\<uuid>","useragent" "string","ipaddress" "string","userid" "string\<uuid>","identityproviderid" "string\<uuid>","createdat" "string\<date time>"},"createdat" "string\<date time>","updatedat" "string\<date time>"},"invitee" {"id" "string\<uuid>","name" "string","ageverified"\ false,"isguest"\ false,"lastlogin" {"id" "string\<uuid>","useragent" "string","ipaddress" "string","userid" "string\<uuid>","identityproviderid" "string\<uuid>","createdat" "string\<date time>"},"createdat" "string\<date time>","updatedat" "string\<date time>"},"createdat" "string\<date time>","updatedat" "string\<date time>"}}'var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("content type", "application/json"); var raw = json stringify({ "body" { "id" "string\<uuid>", "spawndetails" {}, "userid" "string\<uuid>", "invitetype" "string\<friend | channel | location | instance | new user>", "user" { "id" "string\<uuid>", "name" "string", "ageverified" false, "isguest" false, "lastlogin" { "id" "string\<uuid>", "useragent" "string", "ipaddress" "string", "userid" "string\<uuid>", "identityproviderid" "string\<uuid>", "createdat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" }, "invitee" { "id" "string\<uuid>", "name" "string", "ageverified" false, "isguest" false, "lastlogin" { "id" "string\<uuid>", "useragent" "string", "ipaddress" "string", "userid" "string\<uuid>", "identityproviderid" "string\<uuid>", "createdat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" } }); var requestoptions = { method 'patch', headers myheaders, body raw, redirect 'follow' }; fetch("/invite?filter={\\"id\\" \\"string\<uuid>\\",\\"spawndetails\\" {},\\"userid\\" \\"string\<uuid>\\",\\"invitetype\\" \\"string\<friend | channel | location | instance | new user>\\",\\"user\\" {\\"id\\" \\"string\<uuid>\\",\\"name\\" \\"string\\",\\"ageverified\\"\ false,\\"isguest\\"\ false,\\"lastlogin\\" {\\"id\\" \\"string\<uuid>\\",\\"useragent\\" \\"string\\",\\"ipaddress\\" \\"string\\",\\"userid\\" \\"string\<uuid>\\",\\"identityproviderid\\" \\"string\<uuid>\\",\\"createdat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"},\\"invitee\\" {\\"id\\" \\"string\<uuid>\\",\\"name\\" \\"string\\",\\"ageverified\\"\ false,\\"isguest\\"\ false,\\"lastlogin\\" {\\"id\\" \\"string\<uuid>\\",\\"useragent\\" \\"string\\",\\"ipaddress\\" \\"string\\",\\"userid\\" \\"string\<uuid>\\",\\"identityproviderid\\" \\"string\<uuid>\\",\\"createdat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"}", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));require "uri" require "json" require "net/http" url = uri("/invite?filter={\\"id\\" \\"string\<uuid>\\",\\"spawndetails\\" {},\\"userid\\" \\"string\<uuid>\\",\\"invitetype\\" \\"string\<friend | channel | location | instance | new user>\\",\\"user\\" {\\"id\\" \\"string\<uuid>\\",\\"name\\" \\"string\\",\\"ageverified\\"\ false,\\"isguest\\"\ false,\\"lastlogin\\" {\\"id\\" \\"string\<uuid>\\",\\"useragent\\" \\"string\\",\\"ipaddress\\" \\"string\\",\\"userid\\" \\"string\<uuid>\\",\\"identityproviderid\\" \\"string\<uuid>\\",\\"createdat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"},\\"invitee\\" {\\"id\\" \\"string\<uuid>\\",\\"name\\" \\"string\\",\\"ageverified\\"\ false,\\"isguest\\"\ false,\\"lastlogin\\" {\\"id\\" \\"string\<uuid>\\",\\"useragent\\" \\"string\\",\\"ipaddress\\" \\"string\\",\\"userid\\" \\"string\<uuid>\\",\\"identityproviderid\\" \\"string\<uuid>\\",\\"createdat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"}") http = net http new(url host, url port); request = net http patch new(url) request\["accept"] = "application/json" request\["content type"] = "application/json" request body = json dump({ "body" { "id" "string\<uuid>", "spawndetails" {}, "userid" "string\<uuid>", "invitetype" "string\<friend | channel | location | instance | new user>", "user" { "id" "string\<uuid>", "name" "string", "ageverified" false, "isguest" false, "lastlogin" { "id" "string\<uuid>", "useragent" "string", "ipaddress" "string", "userid" "string\<uuid>", "identityproviderid" "string\<uuid>", "createdat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" }, "invitee" { "id" "string\<uuid>", "name" "string", "ageverified" false, "isguest" false, "lastlogin" { "id" "string\<uuid>", "useragent" "string", "ipaddress" "string", "userid" "string\<uuid>", "identityproviderid" "string\<uuid>", "createdat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" } }) response = http request(request) puts response read body import requests import json url = "/invite?filter={\\"id\\" \\"string\<uuid>\\",\\"spawndetails\\" {},\\"userid\\" \\"string\<uuid>\\",\\"invitetype\\" \\"string\<friend | channel | location | instance | new user>\\",\\"user\\" {\\"id\\" \\"string\<uuid>\\",\\"name\\" \\"string\\",\\"ageverified\\"\ false,\\"isguest\\"\ false,\\"lastlogin\\" {\\"id\\" \\"string\<uuid>\\",\\"useragent\\" \\"string\\",\\"ipaddress\\" \\"string\\",\\"userid\\" \\"string\<uuid>\\",\\"identityproviderid\\" \\"string\<uuid>\\",\\"createdat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"},\\"invitee\\" {\\"id\\" \\"string\<uuid>\\",\\"name\\" \\"string\\",\\"ageverified\\"\ false,\\"isguest\\"\ false,\\"lastlogin\\" {\\"id\\" \\"string\<uuid>\\",\\"useragent\\" \\"string\\",\\"ipaddress\\" \\"string\\",\\"userid\\" \\"string\<uuid>\\",\\"identityproviderid\\" \\"string\<uuid>\\",\\"createdat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"},\\"createdat\\" \\"string\<date time>\\",\\"updatedat\\" \\"string\<date time>\\"}" payload = json dumps({ "body" { "id" "string\<uuid>", "spawndetails" {}, "userid" "string\<uuid>", "invitetype" "string\<friend | channel | location | instance | new user>", "user" { "id" "string\<uuid>", "name" "string", "ageverified" false, "isguest" false, "lastlogin" { "id" "string\<uuid>", "useragent" "string", "ipaddress" "string", "userid" "string\<uuid>", "identityproviderid" "string\<uuid>", "createdat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" }, "invitee" { "id" "string\<uuid>", "name" "string", "ageverified" false, "isguest" false, "lastlogin" { "id" "string\<uuid>", "useragent" "string", "ipaddress" "string", "userid" "string\<uuid>", "identityproviderid" "string\<uuid>", "createdat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" }, "createdat" "string\<date time>", "updatedat" "string\<date time>" } }) headers = { 'accept' 'application/json', 'content type' 'application/json' } response = requests request("patch", url, headers=headers, data=payload) print(response text) responses // success \[ { "id" "", "token" "", "identityprovidertype" "", "passcode" "", "targetobjectid" "", "deleteonuse" false, "makeadmin" false, "spawntype" "", "spawndetails" {}, "timed" false, "userid" "", "inviteeid" "", "invitetype" "", "user" { "id" "", "name" "", "ageverified" false, "isguest" false, "invitecode" "", "lastlogin" { "id" "", "useragent" "", "ipaddress" "", "userid" "", "identityproviderid" "", "createdat" "" }, "createdat" "", "updatedat" "" }, "invitee" { "id" "", "name" "", "ageverified" false, "isguest" false, "invitecode" "", "lastlogin" { "id" "", "useragent" "", "ipaddress" "", "userid" "", "identityproviderid" "", "createdat" "" }, "createdat" "", "updatedat" "" }, "channelname" "", "starttime" "", "endtime" "", "createdat" "", "updatedat" "" } ]// not authenticated // general error