{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/projects/","auth":"required","method":"post","params":[{"name":"name","type":"string","default":"","desc":"Project name","required":true,"in":"body","ref":"","_id":"54349b3e0ef9c0080016528c"},{"name":"description","type":"string","default":"","desc":"Project description","required":false,"in":"body","ref":"","_id":"54349b3e0ef9c0080016528b"},{"name":"poster","type":"string","default":"","desc":"url to the project poster frame","required":false,"in":"body","ref":"","_id":"5a8f16109e38820012459e7a"}],"results":{"codes":[{"language":"json","status":200,"name":"Success","code":"{\n  \"id\": \"ab78797a-5344-4513-a724-04d45b976ec9\"\n}"}]},"try":true,"basic_auth":true,"examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Create Project","type":"endpoint","slug":"create-project","excerpt":"Creates a new project.","body":"Creates a project and returns a project id.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"What to do next\",\n  \"body\": \"Creating project only grants access to the user who creates it. In order to assign users to a project use either [Invite User to Project](http://phoenix.readme.io/v3.0/docs/invite-user-to-project) or [Add User to Project](http://phoenix.readme.io/v3.0/docs/add-user-to-project).\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Permissions\"\n}\n[/block]\nOnly users with an account-level role of PROJECT MANAGER or ADMINISTRATOR can create projects.","updates":["54c658822b94bb19003d33fc","54c65a952b94bb19003d3401"],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54349a445b10711400c6c515","createdAt":"2014-10-08T01:58:28.954Z","category":{"sync":{"isSync":false,"url":""},"pages":["543493365b10711400c6c48e","54349a445b10711400c6c515","5434a0fe0ef9c008001652ed","54aafac199f6581600167c9a","54ab036defb39016009e4d85","54ab09c699f6581600167cc4","54ab6a8499f6581600167d42","54abf047ec3be11400c8af25","54abfcf2de18cc1400226dbc","54abfe45ec3be11400c8af64","54ac0037de18cc1400226dc7","54c6a0d5f2ab9319008e81aa","54d52803ba860f0d003de534"],"title":"Projects","slug":"projects","order":3,"from_sync":false,"reference":false,"_id":"543435bfedce040800409244","__v":13,"project":"54343170fa5527080064f449","version":"54343531bfaa3d0800c4d4af","createdAt":"2014-10-07T18:49:35.512Z"},"project":"54343170fa5527080064f449","__v":7,"editedParams":true,"githubsync":"","is_link":false,"user":"54343147fa5527080064f43f","editedParams2":true,"parentDoc":null,"version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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","596e6e42c5b53b00509791b1"],"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","releaseDate":"2014-10-07T18:47:13.086Z","__v":28,"createdAt":"2014-10-07T18:47:13.086Z","forked_from":"54343170fa5527080064f44c"}}

postCreate Project

Creates a new project.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
Project name
description:
string
Project description
poster:
string
url to the project poster frame

Result Format


Documentation

Creates a project and returns a project id. [block:callout] { "type": "warning", "title": "What to do next", "body": "Creating project only grants access to the user who creates it. In order to assign users to a project use either [Invite User to Project](http://phoenix.readme.io/v3.0/docs/invite-user-to-project) or [Add User to Project](http://phoenix.readme.io/v3.0/docs/add-user-to-project)." } [/block] [block:api-header] { "type": "basic", "title": "Permissions" } [/block] Only users with an account-level role of PROJECT MANAGER or ADMINISTRATOR can create projects.

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