Invite someone to the organisation by email
POST
consoleSessioncookie
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthapplication/json- body
email*stringThe address to invite; case-folded when stored.
Format
emailrole*stringThe organisation role to grant.
Value in
"Admin""Member""Viewer"The invitation, and its link when SMTP is not set.
application/json- response
invitation*link*|Format
uriemailed*booleanTrue when the email was sent; false without SMTP, or when the send failed.
Example Request
curl -X POST 'https://example.com/api/v1/org/string/invitations' \ -H 'Content-Type: application/json' \ -d '{ "email": "user@example.com", "role": "Admin"}'Example Response
{ "invitation": { "id": "string", "kind": "invite", "email": "user@example.com", "role": "Admin", "state": "pending", "createdAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "invitedBy": "string" }, "link": "http://example.com", "emailed": true}Was this page helpful?