{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/invitations/","auth":"required","results":{"codes":[{"status":201,"language":"json","code":"{\n  \"created_at\": \"2015-05-27T16:11:23.611631Z\",\n  \"email\": \"coen:::at:::povis.ciri\",\n  \"id\": 20,\n  \"key\": \"54b09c4a194f269a8f71f3e582c94fa431ee28b8\",\n  \"links\": {\n    \"resend\": \"/v1.1/instances/rivia/invitations/20/resend/\",\n    \"self\": \"/v1.1/instances/rivia/invitations/20/\"\n  },\n  \"role\": \"full\",\n  \"state\": \"new\",\n  \"updated_at\": \"2015-05-27T16:11:23.611669Z\"\n}","name":""},{"status":400,"language":"json","code":"{\n  \"email\": [\n    \"Enter a valid email address.\"\n  ]\n}","name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"name":"","code":"curl -X POST \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"email\":\"<email_address>\",\n     \"role\":\"full\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/invitations/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import InstanceInvitation\n\nsyncano.connect(api_key='ACCOUNT_KEY', instance_name=\"INSTANCE_NAME\")\n\nInstanceInvitation.please.create(\n    email=\"EMAIL\",\n    role=\"FULL\"\n)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar InstanceInvitation = connection.InstanceInvitation;\n\nvar options = {\n  \"email\":\"<email_address>\",\n  \"role\":\"full\",\n  \"instanceName\": \"INSTANCE_NAME\"\n};\n\nInstanceInvitation.please().create(options).then(callback)","language":"javascript"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Name of an Instance","required":true,"in":"path","ref":"","_id":"54d4d54ff6c48a0d00f0f028"},{"name":"email","type":"string","default":"","desc":"Email of an Administrator you want to invite (max 254 characters)","required":true,"in":"body","ref":"","_id":"54d4d5feae3d0f0d00f006c7"},{"name":"role","type":"string","default":"","desc":"Role of an Administrator (`full`, `read` or `write`)","required":true,"in":"body","ref":"","_id":"54d4d5feae3d0f0d00f006c6"}]},"next":{"description":"","pages":[]},"title":"Invitation - add (send)","type":"endpoint","slug":"invitations-add","excerpt":"","body":"Allows you to invite new Administrators to a selected instance.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Roles\",\n  \"body\": \"Available admin roles are: \\n- `full` - has read and write access to all the instance data, can add administrators,\\n- `read` - has read and write access to all the instance data, cannot add administrators, \\n- `write` - has read and write access to all the instance data (cannot modify it), cannot add administrators\"\n}\n[/block]\nYou can read more about Admin roles, invitations and in the [Administrators chapter](http://docs.syncano.com/docs/administrators).","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50632bdcde80d004986af","__v":0,"editedParams":true,"parentDoc":null,"user":"54774c47f3736008009e9e0c","category":{"sync":{"isSync":false,"url":""},"pages":["56c50632bdcde80d004986ad","56c50632bdcde80d004986ae","56c50632bdcde80d004986af","56c50632bdcde80d004986b0","56c50632bdcde80d004986b1"],"title":"Invitations (Sent)","slug":"invitations-sent","order":11,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d0049863f","project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":1,"createdAt":"2015-03-17T14:17:51.437Z"},"editedParams2":true,"project":"54774d9af3736008009e9e0e","version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"createdAt":"2015-02-06T14:53:03.591Z","githubsync":""}

postInvitation - add (send)


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of an Instance

Body Params

email:
required
string
Email of an Administrator you want to invite (max 254 characters)
role:
required
string
Role of an Administrator (`full`, `read` or `write`)

Examples


Result Format


Documentation

Allows you to invite new Administrators to a selected instance. [block:callout] { "type": "info", "title": "Roles", "body": "Available admin roles are: \n- `full` - has read and write access to all the instance data, can add administrators,\n- `read` - has read and write access to all the instance data, cannot add administrators, \n- `write` - has read and write access to all the instance data (cannot modify it), cannot add administrators" } [/block] You can read more about Admin roles, invitations and in the [Administrators chapter](http://docs.syncano.com/docs/administrators).

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}