Projects - Update

Service:

Core

API Version:

7.1

Update an existing project's name, abbreviation, description, or restore a project.

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
projectId	path	True	string uuid	The project id of the project to update.
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name	Type	Description
_links	ReferenceLinks	The links to other objects related to this object.
abbreviation	string	Project abbreviation.
capabilities	object	Set of capabilities this project has (such as process template & version control).
defaultTeam	WebApiTeamRef	The shallow ref to the default team.
defaultTeamImageUrl	string	Url to default team identity image.
description	string	The project's description (if any).
id	string	Project identifier.
lastUpdateTime	string	Project last update time.
name	string	Project name.
revision	integer	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

Responses

Name	Type	Description
200 OK	OperationReference	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.project_write	Grants the ability to read and update projects and teams.

Definitions

Name	Description
OperationReference	Reference for an async operation.
OperationStatus	The current status of the operation.
ProjectState	The current state of the project.
ProjectVisibility	Indicates whom the project is visible to.
ReferenceLinks	The class to represent a collection of REST reference links.
TeamProject	Represents a Team Project object.
WebApiTeamRef

OperationReference

Reference for an async operation.

Name	Type	Description
id	string	Unique identifier for the operation.
pluginId	string	Unique identifier for the plugin.
status	OperationStatus	The current status of the operation.
url	string	URL to get the full operation object.

OperationStatus

The current status of the operation.

Name	Type	Description
cancelled	string	The operation was cancelled by the user.
failed	string	The operation completed with a failure.
inProgress	string	The operation is in progress.
notSet	string	The operation does not have a status set.
queued	string	The operation has been queued.
succeeded	string	The operation completed successfully.

ProjectState

The current state of the project.

Name	Type	Description
all	string	All projects regardless of state except Deleted.
createPending	string	Project has been queued for creation, but the process has not yet started.
deleted	string	Project has been deleted.
deleting	string	Project is in the process of being deleted.
new	string	Project is in the process of being created.
unchanged	string	Project has not been changed.
wellFormed	string	Project is completely created and ready to use.

ProjectVisibility

Indicates whom the project is visible to.

Name	Type	Description
private	string	The project is only visible to users with explicit access.
public	string	The project is visible to all.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

TeamProject

Represents a Team Project object.

Name	Type	Description
_links	ReferenceLinks	The links to other objects related to this object.
abbreviation	string	Project abbreviation.
capabilities	object	Set of capabilities this project has (such as process template & version control).
defaultTeam	WebApiTeamRef	The shallow ref to the default team.
defaultTeamImageUrl	string	Url to default team identity image.
description	string	The project's description (if any).
id	string	Project identifier.
lastUpdateTime	string	Project last update time.
name	string	Project name.
revision	integer	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

WebApiTeamRef

Name	Type	Description
id	string	Team (Identity) Guid. A Team Foundation ID.
name	string	Team name
url	string	Team REST API Url