Create a Clause

Your Company APIClauses

POSThttps://api.your-company.example/v1/clauses

AuthenticationRequires bearerAuth.

Description

Creates a draft Clause Library entry for later review and approval.

Request

curl -X POST "https://api.your-company.example/v1/clauses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Mutual liability cap",
  "category": "Risk allocation",
  "text": "Except for excluded claims, each party's aggregate liability will not exceed fees paid or payable in the twelve months before the event giving rise to the claim.",
  "drafting_note": "Use for standard services agreements under the commercial threshold.",
  "tags": [
    "liability",
    "mutual",
    "fees"
  ],
  "owner_id": "usr_01J7Z9K3W8"
}'

const response = await fetch("https://api.your-company.example/v1/clauses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "title": "Mutual liability cap",
      "category": "Risk allocation",
      "text": "Except for excluded claims, each party's aggregate liability will not exceed fees paid or payable in the twelve months before the event giving rise to the claim.",
      "drafting_note": "Use for standard services agreements under the commercial threshold.",
      "tags": [
        "liability",
        "mutual",
        "fees"
      ],
      "owner_id": "usr_01J7Z9K3W8"
    }),
});

import requests

response = requests.post(
    "https://api.your-company.example/v1/clauses",
    headers={
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    json={
      "title": "Mutual liability cap",
      "category": "Risk allocation",
      "text": "Except for excluded claims, each party's aggregate liability will not exceed fees paid or payable in the twelve months before the event giving rise to the claim.",
      "drafting_note": "Use for standard services agreements under the commercial threshold.",
      "tags": [
        "liability",
        "mutual",
        "fees"
      ],
      "owner_id": "usr_01J7Z9K3W8"
    },
)

Response201JSON

{
  "id": "cls_01J8V1B4H6",
  "title": "Mutual liability cap",
  "category": "Risk allocation",
  "text": "string",
  "drafting_note": "string",
  "fallback_positions": [
    {
      "label": "Two times fees",
      "text": "string",
      "requires_approval": true
    }
  ],
  "status": "draft",
  "version": 0,
  "tags": [
    "string"
  ],
  "owner_id": "usr_01J7Z9K3W8",
  "reviewed_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Request body

application/jsonrequired

titlestringrequired

categorystringrequired

textstringrequired

drafting_notestring

fallback_positionsobject[]

Array item fields

labelstringrequired

textstringrequired

Approved alternative language.

requires_approvalbooleanrequired

Whether using this fallback triggers an Approval Chain.

tagsstring[]

owner_idstringrequired

Responses

201The created draft Clause.application/json

idstringrequired

titlestringrequired

categorystringrequired

textstringrequired

Preferred contract language.

drafting_notestring | null

Internal guidance for editors.

fallback_positionsobject[]

Array item fields

labelstringrequired

textstringrequired

Approved alternative language.

requires_approvalbooleanrequired

Whether using this fallback triggers an Approval Chain.

statusstringrequired

Allowed values: draftapprovedretired

Governance status of a Clause version.

versionintegerrequired

tagsstring[]required

owner_idstringrequired

reviewed_atstring | null

updated_atstring <date-time>required

Example response

{
  "id": "cls_01J8V1B4H6",
  "title": "Mutual liability cap",
  "category": "Risk allocation",
  "text": "string",
  "drafting_note": "string",
  "fallback_positions": [
    {
      "label": "Two times fees",
      "text": "string",
      "requires_approval": true
    }
  ],
  "status": "draft",
  "version": 0,
  "tags": [
    "string"
  ],
  "owner_id": "usr_01J7Z9K3W8",
  "reviewed_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

401The API key is missing, malformed, expired, or revoked.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Provide a valid bearer API key.",
    "request_id": "req_01JAZA0P8M"
  }
}

403The API key does not have permission for this action.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission.",
    "request_id": "req_01JAZA0P8M"
  }
}

422One or more request fields are invalid.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "validation_error",
    "message": "Correct the highlighted request fields.",
    "request_id": "req_01JAZA0P8M",
    "details": [
      {
        "field": "target_signature_date",
        "issue": "must be today or later"
      }
    ]
  }
}