Sign in
latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Project Management

Edit Project

Allows you to edit project settings such as name and desired delivery date, after creation or cloning. The editing function stops once the first upload of input units begin and the NOT ACTIVE project state is changed.

Note: both fields must be provided to update either one of them.

Permission Required: Update Project Properties

put/v2.0/public/projects/{projectId}

Path parameters

projectIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

Project ID.

Request body

projectNamestring required

Name of project.

desiredDeliveryDatestring date nullable required

Desired date of delivery for project in UTC format <yyyy-mm-dd>. If left as null, no desired delivery date is assigned.

metatagsobject nullable required

Metatags provide for the ability to assign metadata to projects in the form of key-value pairs. Although there are no inherent types of metatags, they enable customers to categorize a project by purpose, owner, environment, or other criteria. Defined.ai does not perform any actions on metatags that customers submit. DO NOT SUBMIT PERSONALLY IDENTIFIABLE INFORMATION (PII) in a Metatag.

If left as null, no metatags are assigned.

When set, the root-level properties support string, object, and array data types (data types do not belong to these three will be converted to string type), while properties at inner level support all valid JSON data types.

Below is an example on how to use metatags:

 { 
     "rootString":  "This is a string",
     "rootObject":  {
		"innerBoolean": true,
		"innerNumber": 1,
		"innerString": "This is another string",
			"innerNull": null,
		"innerObject": {
			},
		"innerArray": []
	},
     "rootArray": [1, 2, 3, 4]
 }

Response

Accepted. Project is updated asynchronously. No response body.