{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/projects.json","auth":"required","params":[{"name":"name","type":"string","default":"","desc":"The name of the project.","required":true,"in":"body","ref":"","_id":"554bd10ef2829e1900587225"},{"name":"shortName","type":"string","default":"","desc":"Ths shortname of your project, max 7 characters.","required":false,"in":"body","ref":"","_id":"554bd10ef2829e1900587226"},{"name":"description","type":"string","default":"","desc":"The description of the project, max 1000 characters.","required":false,"in":"body","ref":"","_id":"554bd10ef2829e1900587228"},{"name":"rate","type":"double","default":"0","desc":"Project default rate per hour. Please note that the rate must be non-negative.","required":false,"in":"body","ref":"","_id":"554bd10ef2829e1900587227"},{"name":"budget","type":"double","default":"0","desc":"Budget for project. Please note that the budget must be non-negative.","required":false,"in":"body","ref":"","_id":"554bd10ef2829e190058722a"},{"name":"status","type":"int","default":"","desc":"{id: statusId}, can get from /api/v1/ProjectData/statuses","required":false,"in":"body","ref":"","_id":"554be9f4374fec0d007e5ff7"},{"name":"priority","type":"int","default":"","desc":"{id: priorityId}, can get from /api/v1/ProjectData/priorities","required":false,"in":"body","ref":"","_id":"554be9f4374fec0d007e5ff8"},{"name":"manager","type":"int","default":"","desc":"{id: managerId}, can get from /api/v1/ProjectData/managers","required":false,"in":"body","ref":"","_id":"554be9f4374fec0d007e5ff9"},{"name":"custom1","type":"int","default":"","desc":"{id: custom1Id}, can get from /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"554be9f4374fec0d007e5ffa"},{"name":"custom2","type":"int","default":"","desc":"{id: custom2Id}, can get from /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"555aae88bdbf120d005a9148"},{"name":"custom3","type":"int","default":"","desc":"{id: custom3Id}, can get from /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"555aae88bdbf120d005a9147"},{"name":"custom4","type":"int","default":"","desc":"{id: custom4Id}, can get from /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"555aae88bdbf120d005a9146"},{"name":"chargeCode","type":"int","default":"","desc":"{id: chargeCodeId}, can get from /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"554bd10ef2829e1900587229"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n    status: \"Okay\",\n    project:  {\n        id:78888,\n        name: 'Rennovation at 42 Wallaby Way',\n        shortName: 'Wallaby',\n        description: 'Major rennovation project for the dentist in Sydney.',\n        budget: 250000,\n        rate: 89.90,\n        chargeCode: {\n            \"id\": 1234\n        },\n        manager: {\n            \"id\": 2345\n        }\n    }\n}","name":""}]},"settings":"","examples":{"codes":[{"name":"jQuery","code":"$.ajax({\n      url: 'https://api.projectmanager.com/api/v1/projects.json',\n      type: 'post',\n      headers: {\n            apiKey: '[apiKey]',\n      },\n      dataType: 'json',\n      data: {\n            name: 'Rennovation at 42 Wallaby Way',\n            shortName: 'Wallaby',\n            description: 'Major rennovation project for the dentist in Sydney.',\n            budget: 250000,\n            rate: 89.90,\n            chargeCode: {\n              \"id\": 1234\n            },\n            manager: {\n              \"id\": 2345\n            },\n      },\n  success: function (data) {\n\t\t\tconsole.info(data);\n  }\n});","language":"javascript"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create a Project","type":"endpoint","slug":"create-a-project-1","excerpt":"A Project resource represents a planned and trackable project within ProjectManager.com.\n\nUse this API to create a single project in Project Manager.com. You can specify a minimum of Project Name to create a Project via the API.","body":"This call will let you create a brand new project for the registered user.\n\nThe parameters `chargeCode`, `customer`, `manager`, `priority` and `status` are specific to the customer's account and need to be referenced by their unique IDs. You can get a list of valid IDs for each of these variables by calling one of the project data endpoints. Eg:  /api/v1/ProjectData/statuses.","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"554a7f016b448d0d00646b94","githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["554a69ca156a480d00e2924a","554a69d40b54d30d007fe129","554a6c8258f5650d00ae440d","554a6c8f58f5650d00ae4410","554a6c990b54d30d007fe131","554a7c0e38e3620d00821920","554a7e9d6b448d0d00646b92","554a7ea838e3620d00821929","554a7f016b448d0d00646b94","5575c1dbacd0472d000ac9ba"],"title":"Projects","slug":"projects","order":1,"from_sync":false,"reference":false,"_id":"554a69ba0b54d30d007fe128","project":"5548466bd2c8410d006c2143","version":"5548466bd2c8410d006c2146","__v":10,"createdAt":"2015-05-06T19:21:30.961Z"},"editedParams2":true,"user":"55484649b2581a0d00913ff3","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5548466cd2c8410d006c2147","554a69ba0b54d30d007fe128","554a7f3338e3620d0082192e","5565162e03b6710d00916942","55651a0c65a1130d00400c2b","55651d4565a1130d00400c2f","55651e0165a1130d00400c32","5565217903b6710d0091695f"],"_id":"5548466bd2c8410d006c2146","createdAt":"2015-05-05T04:26:19.796Z","project":"5548466bd2c8410d006c2143","__v":8,"releaseDate":"2015-05-05T04:26:19.796Z"},"editedParams":true,"parentDoc":null,"project":"5548466bd2c8410d006c2143","__v":6,"createdAt":"2015-05-06T20:52:17.055Z"}

postCreate a Project

A Project resource represents a planned and trackable project within ProjectManager.com. Use this API to create a single project in Project Manager.com. You can specify a minimum of Project Name to create a Project via the API.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
The name of the project.
shortName:
string
Ths shortname of your project, max 7 characters.
description:
string
The description of the project, max 1000 characters.
rate:
double0
Project default rate per hour. Please note that the rate must be non-negative.
budget:
double0
Budget for project. Please note that the budget must be non-negative.
status:
integer
{id: statusId}, can get from /api/v1/ProjectData/statuses
priority:
integer
{id: priorityId}, can get from /api/v1/ProjectData/priorities
manager:
integer
{id: managerId}, can get from /api/v1/ProjectData/managers
custom1:
integer
{id: custom1Id}, can get from /api/v1/ProjectData/customFields
custom2:
integer
{id: custom2Id}, can get from /api/v1/ProjectData/customFields
custom3:
integer
{id: custom3Id}, can get from /api/v1/ProjectData/customFields
custom4:
integer
{id: custom4Id}, can get from /api/v1/ProjectData/customFields
chargeCode:
integer
{id: chargeCodeId}, can get from /api/v1/ProjectData/customFields

Examples


Result Format


Documentation

This call will let you create a brand new project for the registered user. The parameters `chargeCode`, `customer`, `manager`, `priority` and `status` are specific to the customer's account and need to be referenced by their unique IDs. You can get a list of valid IDs for each of these variables by calling one of the project data endpoints. Eg: /api/v1/ProjectData/statuses.