Projects - Set Project Properties

Create, update, and delete team project properties.

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}/properties?api-version=6.1-preview.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 team project ID.

api-version
query True

string

Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.

Request Body

Media Types: "application/json-patch+json"

Name Type Description
from

string

The path to copy from for the Move/Copy operation.

op

Operation

The patch operation

path

string

The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The "-" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).

value

object

The value for the operation. This is either a primitive or a JToken.

Responses

Name Type Description
200 OK

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.

Examples

Create or update a team project property
Delete a team project property

Create or update a team project property

Sample request

PATCH https://dev.azure.com/fabrikam/_apis/projects/{projectId}/properties?api-version=6.1-preview.1

[
  {
    "op": "add",
    "path": "/Alias",
    "value": "Frabrikam"
  }
]

Sample response

Delete a team project property

Sample request

PATCH https://dev.azure.com/fabrikam/_apis/projects/{projectId}/properties?api-version=6.1-preview.1

[
  {
    "op": "remove",
    "path": "/Alias"
  }
]

Sample response

Definitions

Name Description
JsonPatchDocument

The JSON model for JSON Patch Operations

Operation

The patch operation

JsonPatchDocument

The JSON model for JSON Patch Operations

Name Type Description
from

string

The path to copy from for the Move/Copy operation.

op

Operation

The patch operation

path

string

The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The "-" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).

value

object

The value for the operation. This is either a primitive or a JToken.

Operation

The patch operation

Name Type Description
add

string

copy

string

move

string

remove

string

replace

string

test

string