{"id":320,"date":"2014-10-15T00:38:41","date_gmt":"2014-10-15T00:38:41","guid":{"rendered":"http:\/\/www.improvely.com\/docs\/?p=320"},"modified":"2014-10-15T01:11:52","modified_gmt":"2014-10-15T01:11:52","slug":"api-post-user-permission","status":"publish","type":"post","link":"https:\/\/www.improvely.com\/docs\/api-post-user-permission","title":{"rendered":"POST \/user_permission.json"},"content":{"rendered":"

Description:<\/b> Grants a user permission to view or administrate a specific project.<\/p>\n

API Endpoint URL:<\/b> https:\/\/api.improvely.com\/v1\/user_permission.json<\/code><\/p>\n\n\n\n\n\n\n\n
Attribute<\/th>\nRequired<\/th>\nDefault<\/th>\nDescription<\/th>\n<\/tr>\n
key<\/td>\n<\/i><\/td>\n<\/td>\nYour API key<\/td>\n<\/tr>\n
id<\/td>\n<\/td>\n<\/td>\nThe ID number of the user to delete.<\/td>\n<\/tr>\n
email<\/td>\n<\/td>\n<\/td>\nThe e-mail address of the user to delete.<\/td>\n<\/tr>\n
project<\/td>\n<\/i><\/td>\n<\/td>\nThe ID number of the Improvely project to grant this permission to. You can retrieve this number from the top of the Project Settings page of the relevant project in your account. <\/td>\n<\/tr>\n
permission<\/td>\n<\/i><\/td>\n<\/td>\n“view” will provide read-only access to the project’s reports
“full” will provide full administrative access to the project’s reports, links and settings<\/td>\n<\/tr>\n<\/table>\n

Note:<\/b> Either id<\/code> or email<\/code> must be provided to identify which user to grant this permission to.<\/p>\n

Example request:<\/strong><\/p>\n

\r\ncurl https:\/\/api.improvely.com\/v1\/user_permission.json \\\r\n  -X POST \\\r\n  -d 'key=90c0d64fds653338as6869e54267e05&email=dan@awio.com&project=1&permission=full'\r\n<\/pre>\n
Example successful response (HTTP status code 200):<\/strong><\/p>\n
\r\n{\r\n    "status": "success"\r\n}\r\n<\/pre>\n
Example failure response (HTTP status code: 400):<\/strong><\/p>\n
\r\n{\r\n    "status": "error",\r\n    "type": "parameters",\r\n    "message": "Missing parameter: either `id` or `email` must be provided."\r\n}\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Description: Grants a user permission to view or administrate a specific project. API Endpoint URL: https:\/\/api.improvely.com\/v1\/user_permission.json Attribute Required Default Description key Your API key id The ID number of the user to delete. email The e-mail address of the user to delete. project The ID number of the Improvely project to grant this permission to. […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-320","post","type-post","status-publish","format-standard","hentry","category-api"],"_links":{"self":[{"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/posts\/320","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/comments?post=320"}],"version-history":[{"count":5,"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/posts\/320\/revisions"}],"predecessor-version":[{"id":330,"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/posts\/320\/revisions\/330"}],"wp:attachment":[{"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/media?parent=320"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/categories?post=320"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.improvely.com\/docs\/wp-json\/wp\/v2\/tags?post=320"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}