Update a project | Monite Documentation

Update a project.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequired

Request

This endpoint expects an object.

codestringOptionalformat: "^[a-zA-Z0-9]+$"1-20 characters

A user-defined identifier of this project.

colorstringOptional<=128 characters

Project color as a CSS-compatible value. Client applications can use this to color-code the projects or project-related data.

Project color as a [CSS-compatible](https://developer.mozilla.org/en-US/docs/Web/CSS/color) value. Client applications can use this to color-code the projects or project-related data.

descriptionstringOptional<=1024 characters

A user-defined description of the project.

end_datestringOptionalformat: "date"

Project end date. If specified, must be later than or equal to the start date.

namestringOptional1-255 characters

The project name.

parent_idstringOptionalformat: "uuid"

Unused. Reserved for future use.

partner_metadatamap from strings to anyOptional

Metadata for partner needs.

start_datestringOptionalformat: "date"

Project start date.

tag_idslist of stringsOptional

A list of IDs of user-defined tags (labels) assigned to this project.

Response

Successful Response

idstringformat: "uuid"

A unique ID assigned to this project.

created_atdatetime

UTC date and time when this project was created.

updated_atdatetime

UTC date and time when this project was last updated.

entity_idstringformat: "uuid"

ID of the entity that owns this project.

namestring1-255 characters

The project name.

codestringformat: "^[a-zA-Z0-9]+$"1-20 characters

A user-defined identifier of this project.

colorstring<=128 characters

Project color as a CSS-compatible value. Client applications can use this to color-code the projects or project-related data.

Project color as a [CSS-compatible](https://developer.mozilla.org/en-US/docs/Web/CSS/color) value. Client applications can use this to color-code the projects or project-related data.

created_by_entity_user_idstringformat: "uuid"

ID of the entity user who created this project, or null if it was created using a partner access token.

descriptionstring<=1024 characters

A user-defined description of the project.

end_datestringformat: "date"

Project end date.

parent_idstringformat: "uuid"

Unused. Reserved for future use.

partner_metadatamap from strings to any

Metadata for partner needs.

start_datestringformat: "date"

Project start date.

tagslist of objects

A list of user-defined tags (labels) assigned to this project.

Errors

400

Patch Projects ID Request Bad Request Error

401

Patch Projects ID Request Unauthorized Error

403

Patch Projects ID Request Forbidden Error

404

Patch Projects ID Request Not Found Error

422

Patch Projects ID Request Unprocessable Entity Error

429

Patch Projects ID Request Too Many Requests Error

1	import requests
2
3	url = "https://api.sandbox.monite.com/v1/projects/project_id"
4
5	payload = {}
6	headers = {
7	"x-monite-version": "2024-05-25",
8	"x-monite-entity-id": "9d2b4c8f-2087-4738-ba91-7359683c49a4",
9	"Authorization": "Bearer <token>",
10	"Content-Type": "application/json"
11	}
12
13	response = requests.patch(url, json=payload, headers=headers)
14
15	print(response.json())

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"entity_id": "entity_id",
6	"name": "Marketing",
7	"code": "code",
8	"color": "red",
9	"created_by_entity_user_id": "created_by_entity_user_id",
10	"description": "description",
11	"end_date": "end_date",
12	"parent_id": "parent_id",
13	"partner_metadata": {
14	"key": "value"
15	},
16	"start_date": "start_date",
17	"tags": [
18	{
19	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
20	"created_at": "2022-09-07T16:35:18Z",
21	"updated_at": "2022-09-07T16:35:18Z",
22	"name": "Marketing",
23	"category": "document_type",
24	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
25	"description": "Tag for the Marketing Department"
26	}
27	]
28	}

Authentication

Path parameters

Headers

Request

Response

Errors