Start Today

← Documentation

Create Contract

Prerequisites

  • The caller must provide a contract name and a project id.

Authorization

  • API key (via the X-API-KEY header).

Parameters

Request Body

Field nameDescriptionFormat
nameThe name of the contractString
descriptionThe description of the contractString
projectIdThe ID of the projectUUID

Response Body

Field nameDescriptionFormat
idThe ID of the created contractUUID
nameThe name of the contractString
modifiedAtTimestamp when the contract was updatedDateTime
modifiedByThe user who last modified the contractString
projectIdThe ID of the projectUUID
createdAtTimestamp when the contract was createdDateTime

Examples

Contract

    {
      "name": "project-contract",
      "description": "example project contract",
      "projectId": "00000000-0000-0000-0000-000000000111"
    }
    ```
    ```json Response
    {
      "id": "00000000-0000-0000-0000-000000001111",
      "name": "project-contract",
      "modifiedAt": "2026-01-01T00:00:00.000000000Z",
      "modifiedBy": "John Doe",
      "projectId": "00000000-0000-0000-0000-000000000111",
      "createdAt": "2026-01-01T00:00:00.000000000Z"
    }
    ```

  

####

Read more