Create a project

POST

/projects

Create a new project.

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

namestringRequired

The project name.

codestringOptional

Project code

colorstringOptional

Project color

descriptionstringOptional

Description of project

end_datestringOptional

Project end date

parent_idstringOptional

Parent project ID

partner_metadatamap from strings to anyOptional

Project metadata

start_datestringOptional

Project start date

tag_idslist of stringsOptional

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

Response

This endpoint returns an object.

idstring

A unique ID assigned to this project.

created_atdatetime

Project created at

updated_atdatetime

Last time project was updated at

entity_idstring

The ID of the entity to which the project was issued.

namestring

The project name.

codestringOptional

Project code

colorstringOptional

Project color

created_by_entity_user_idstringOptional

Project created by entity user

descriptionstringOptional

Description of project

end_datestringOptional

Project end date

parent_idstringOptional

Parent project ID

partner_metadatamap from strings to anyOptional

Project metadata

start_datestringOptional

Project start date

tagslist of objectsOptional

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

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/projects \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "name": "Marketing"
8 }'

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": "color",
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 }