Create a Clause

Redline API›Clauses

POSThttps://api.redline.example/v1/clauses

AuthRequires authentication via bearerAuth.

Description

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

Request

cURLJavaScriptPython

Copy

curl -X POST "https://api.redline.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.redline.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.redline.example/v1/clauses",
    headers={
      "Authorization": "Bearer YOUR_TOKEN"
    },
    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"
    },
)

Response201JSONCopy

{
  "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

titlebodystringrequired

categorybodystringrequired

textbodystringrequired

drafting_notebodystring

fallback_positionsbodyobject[]

tagsbodystring[]

owner_idbodystringrequired

Responses

201The created draft Clause.application/json

idstringrequired

titlestringrequired

categorystringrequired

textstringrequired

Preferred contract language.

drafting_notestring | null

Internal guidance for editors.

fallback_positionsobject[]

statusstringrequired

Governance status of a Clause version.

versionintegerrequired

tagsstring[]required

owner_idstringrequired

reviewed_atstring | null

updated_atstring <date-time>required

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

errorobjectrequired

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

errorobjectrequired

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

errorobjectrequired