{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/projects/{projectId}.json","auth":"required","results":{"codes":[{"name":"","code":"{\n\t\tstatus: \"Okay\",\n    project:{\n        \"description\": null,\n        \"shortName\": \"TAPIa30dfsdfsdf\",\n        \"rate\": 111.00,\n        \"budget\": 5501.00,\n        \"manager\": {\"id\": 1801},\n        \"customer\": {\"id\": 3070},\n        \"priority\": {\"id\": 16169},\n        \"status\": {\"id\": 4638},\n        \"chargeCode\": null,\n        \"name\": \"TEST3004\"\n    }\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"javascript","code":"var project = {\n    \"description\": null,\n    \"shortName\": \"TESTAPa\",\n    \"rate\": 111.00,\n    \"budget\": 5501.00,\n    \"manager\": {\n        \"id\": 1801\n    },\n    \"customer\": {\n          \"id\": 3070\n     },\n    \"priority\": {\n          \"id\": 16169\n     },\n     \"status\": {\n           \"id\": 4638\n     },\n     \"chargeCode\": null,\n     \"name\": \"TESTAPIa\"\n}\n$.ajax({\n\t\ttype: \"PUT\", \n\t\turl: \"/api/v1/projects/\"+projectId+\".json\", \n\t\tcontentType: 'application/json', \n\t\tdataType: \"json\", \n\t\tsuccess: worked,\n\t\tdata: JSON.stringify(project),\n\t\theaders: { apiKey: apiKey }\n });"}]},"method":"put","params":[{"name":"name","type":"string","default":"","desc":"The name of the project.","required":true,"in":"body","ref":"","_id":"5565130c65a1130d00400c13"},{"name":"shortName","type":"string","default":"","desc":"Ths shortname of your project. Maximum 7 characters.","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c12"},{"name":"description","type":"string","default":"","desc":"The description of your project. Maximum 1000 characters.","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c11"},{"name":"rate","type":"double","default":"0","desc":"Decimal, The project's default rate per hour.","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c10"},{"name":"budget","type":"double","default":"0","desc":"Decimal.  The budget for the project.","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c0f"},{"name":"chargeCode","type":"int","default":"","desc":"{id: chargeCodeId}. The charge code Id for the project. Retrieve using project data endpoint: /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c07"},{"name":"status","type":"int","default":"","desc":"{id: statusId}. The project status Id. Retrieve using project data endpoint: /api/v1/ProjectData/statuses","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c0e"},{"name":"priority","type":"int","default":"","desc":"{id: priorityId}. The project priority Id. Retrieve using project data endpoint: /api/v1/ProjectData/priorities","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c0d"},{"name":"manager","type":"int","default":"","desc":"{id: managerId}. The project manager Id for the project. Retrieve using project data endpoint: /api/v1/ProjectData/managers","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c0c"},{"name":"custom1","type":"int","default":"","desc":"{id: custom1Id}.  Retrieve using project data endpoint: /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c0b"},{"name":"custom2","type":"int","default":"","desc":"{id: custom2Id}. Retrieve using pproject data endpoint: /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c0a"},{"name":"custom3","type":"int","default":"","desc":"{id: custom3Id}.  Retrieve using project data endpoint: /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c09"},{"name":"custom4","type":"int","default":"","desc":"{id: custom4Id}. Retrieve using project data endpoint: /api/v1/ProjectData/customFields","required":false,"in":"body","ref":"","_id":"5565130c65a1130d00400c08"}]},"next":{"description":"","pages":[]},"title":"Update a Project","type":"endpoint","slug":"create-a-project","excerpt":"A Project resource represents a planned and track-able project within ProjectManager.com.\n\nUse this API to update a single Project within ProjectManager.com.","body":"Updates a given project with the supplied data.","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"554a7e9d6b448d0d00646b92","githubsync":"","parentDoc":null,"__v":9,"editedParams":true,"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"},"createdAt":"2015-05-06T20:50:37.977Z","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,"project":"5548466bd2c8410d006c2143","user":"55484649b2581a0d00913ff3"}

putUpdate a Project

A Project resource represents a planned and track-able project within ProjectManager.com. Use this API to update a single Project within ProjectManager.com.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
The name of the project.
shortName:
string
Ths shortname of your project. Maximum 7 characters.
description:
string
The description of your project. Maximum 1000 characters.
rate:
double0
Decimal, The project's default rate per hour.
budget:
double0
Decimal. The budget for the project.
chargeCode:
integer
{id: chargeCodeId}. The charge code Id for the project. Retrieve using project data endpoint: /api/v1/ProjectData/customFields
status:
integer
{id: statusId}. The project status Id. Retrieve using project data endpoint: /api/v1/ProjectData/statuses
priority:
integer
{id: priorityId}. The project priority Id. Retrieve using project data endpoint: /api/v1/ProjectData/priorities
manager:
integer
{id: managerId}. The project manager Id for the project. Retrieve using project data endpoint: /api/v1/ProjectData/managers
custom1:
integer
{id: custom1Id}. Retrieve using project data endpoint: /api/v1/ProjectData/customFields
custom2:
integer
{id: custom2Id}. Retrieve using pproject data endpoint: /api/v1/ProjectData/customFields
custom3:
integer
{id: custom3Id}. Retrieve using project data endpoint: /api/v1/ProjectData/customFields
custom4:
integer
{id: custom4Id}. Retrieve using project data endpoint: /api/v1/ProjectData/customFields

Examples


Result Format


Documentation

Updates a given project with the supplied data.