Skip to main content
POST
/
projects
Create a project
curl --request POST \
  --url https://api.sandbox.monite.com/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "name": "Marketing",
  "code": "<string>",
  "color": "<string>",
  "description": "<string>",
  "end_date": "2023-12-25",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "partner_metadata": {},
  "start_date": "2023-12-25",
  "tag_ids": []
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Marketing",
  "code": "<string>",
  "color": "<string>",
  "created_by_entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "end_date": "2023-12-25",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "partner_metadata": {},
  "start_date": "2023-12-25",
  "tags": [
    {
      "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "created_at": "2022-09-07T16:35:18.484507+00:00",
      "updated_at": "2022-09-07T16:35:18.484507+00:00",
      "name": "Marketing",
      "category": "department",
      "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "description": "Tag for the Marketing Department"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
​
name
string
required

The project name.

Required string length: 1 - 255
Example:

"Marketing"

​
code
string

A user-defined identifier of this project.

Required string length: 1 - 20
​
color
string

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

Maximum string length: 128
Examples:

"red"

"#ff0000"

"#f00"

​
description
string

A user-defined description of the project.

Maximum string length: 1024
​
end_date
string<date>

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

​
parent_id
string<uuid>

Unused. Reserved for future use.

​
partner_metadata
object

Metadata for partner needs.

​
start_date
string<date>

Project start date.

​
tag_ids
string<uuid>[]

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

Response

Successful Response

​
id
string<uuid>
required

A unique ID assigned to this project.

​
created_at
string<date-time>
required

UTC date and time when this project was created.

​
updated_at
string<date-time>
required

UTC date and time when this project was last updated.

​
entity_id
string<uuid>
required

ID of the entity that owns this project.

​
name
string
required

The project name.

Required string length: 1 - 255
Example:

"Marketing"

​
code
string

A user-defined identifier of this project.

Required string length: 1 - 20
​
color
string

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

Maximum string length: 128
Examples:

"red"

"#ff0000"

"#f00"

​
created_by_entity_user_id
string<uuid>

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

​
description
string

A user-defined description of the project.

Maximum string length: 1024
​
end_date
string<date>

Project end date.

​
parent_id
string<uuid>

Unused. Reserved for future use.

​
partner_metadata
object

Metadata for partner needs.

​
start_date
string<date>

Project start date.

​
tags
object[]

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