Planfix API project.update / Update a project's data

Function for updating project data. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="project.update">
  <account></account>
  <sid></sid>
  <project>
    <id></id>
    <general></general>
    <title></title>
    <description></description>
    <owner>
      <id></id>
    </owner>
    <client>
      <id></id>
    </client>
    <status></status>
    <hidden></hidden>
    <hasEndDate></hasEndDate>
    <endDate></endDate>
    <group>
      <id></id>
    </group>
    <parent>
      <id></id>
    </parent>
    <auditors>
      <id></id>
      <id></id>
      <!-- ... -->
    </auditors>
    <managers>
      <id></id>
      <id></id>
      <!-- ... -->
    </managers>
    <workers>
      <id></id>
      <id></id>
      <!-- ... -->
    </workers>
    <customData>
      <customValue>
        <id></id>
        <value></value>
      </customValue>
      <!-- ... -->
    </customData>
  </project>
  <signature></signature>
</request>

Name	Type	Value	Notes
sid	string(32)	session key	created as a result of passing authentication Authentication
id	int	Identifier of the project being edited	can be obtained from a function for getting lists or as a result of executing the add function
general	int	Number of project being edited	used when there is no ID parameter
title	string	Project name	not required
description	string	Description of the project set by the user	not required
owner			not required
owner.id	int	identifier of the user who will be the project creator.	value 0 (zero) is allowed. not required.
client			not required.
client.id	int	counterparty identifier	value 0 (zero) allowed.
status	enum	new project status	for a list of valid values for this field, see the project statuses in the constants section. not required.
hidden	bool	hidden	not required.
hasEndDate	bool	whether or not there is an end date	not required.
endDate	DateTime		only used if hasEndDate is true. not required.
group			not required.
group.id	int	project group identifier
parent			not required.
parent.id	int	parent project identifier
auditors		project auditors	not required.
auditors.id	int	project auditors identifier
managers		project managers	not required.
managers.id	int	project manager identifier
assignees		project default assignees	not required.
assignees.id	int	default project assignee identifier
customData		project custom field values
customData.customValue.id		project custom field identifier
customData.customValue.value		project custom field value

Parameters that are not required do not need to be passed in the request. If they are not passed, the original values will be preserved.

Successful execution of the request results in the following response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <project>
    <id></id>
  </project>
</response>

Name	Type	Value	Notes
id	int	identifier	equal to the identifier passed in the request

Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To

• Planfix API: Projects
• Error codes
• List of functions