{"__v":1,"_id":"54ab09c699f6581600167cc4","category":{"__v":13,"_id":"543435bfedce040800409244","pages":["543493365b10711400c6c48e","54349a445b10711400c6c515","5434a0fe0ef9c008001652ed","54aafac199f6581600167c9a","54ab036defb39016009e4d85","54ab09c699f6581600167cc4","54ab6a8499f6581600167d42","54abf047ec3be11400c8af25","54abfcf2de18cc1400226dbc","54abfe45ec3be11400c8af64","54ac0037de18cc1400226dc7","54c6a0d5f2ab9319008e81aa","54d52803ba860f0d003de534"],"project":"54343170fa5527080064f449","version":"54343531bfaa3d0800c4d4af","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-07T18:49:35.512Z","from_sync":false,"order":3,"slug":"projects","title":"Projects"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"54343170fa5527080064f449","user":"54343147fa5527080064f43f","version":{"__v":27,"_id":"54343531bfaa3d0800c4d4af","forked_from":"54343170fa5527080064f44c","project":"54343170fa5527080064f449","createdAt":"2014-10-07T18:47:13.086Z","releaseDate":"2014-10-07T18:47:13.086Z","categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"updates":["54c65c04f2ab9319008e8127"],"next":{"pages":[],"description":""},"createdAt":"2015-01-05T22:01:42.422Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"","code":"// Success\n{}","language":"json","status":204}]},"auth":"required","params":[{"_id":"54ab09c699f6581600167cc7","ref":"","in":"path","required":true,"desc":"The id of the project","default":"","type":"string","name":"projectId"},{"_id":"54ab09c699f6581600167cc6","ref":"","in":"body","required":true,"desc":"Valid email address","default":"","type":"string","name":"recipientEmail"},{"_id":"54ab09c699f6581600167cc5","ref":"","in":"body","required":true,"desc":"The id of the roleTemplate that will be applied by default to this user","default":"","type":"string","name":"roleTemplateId"}],"url":"/projects/:projectId/invitation"},"isReference":false,"order":6,"body":"This endpoint can be used by used by Project Owners to invite users who either have no user account, or who do not share projects with the current user (which makes the user to be invited \"invisible\" to the current user).\n\nThis triggers an email to be sent containing an invite link with a unique token. The recipient can then be added to the project by either logging in or by self-provisioning an account.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Permissions\"\n}\n[/block]\nA user must be a PROJECT OWNER to add or invite users to a project. Users with an account-level role of ADMINISTRATOR can add or invite users to any project.","excerpt":"Send an email invitation to a user","slug":"invite-user-to-project","type":"endpoint","title":"Invite User to Project"}

postInvite User to Project

Send an email invitation to a user

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

projectId:
required
string
The id of the project

Body Params

recipientEmail:
required
string
Valid email address
roleTemplateId:
required
string
The id of the roleTemplate that will be applied by default to this user

Result Format


Documentation

This endpoint can be used by used by Project Owners to invite users who either have no user account, or who do not share projects with the current user (which makes the user to be invited "invisible" to the current user). This triggers an email to be sent containing an invite link with a unique token. The recipient can then be added to the project by either logging in or by self-provisioning an account. [block:api-header] { "type": "basic", "title": "Permissions" } [/block] A user must be a PROJECT OWNER to add or invite users to a project. Users with an account-level role of ADMINISTRATOR can add or invite users to any project.

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 }}