Create a Turn

Redline API›Turns

POSThttps://api.redline.example/v1/matters/{matter_id}/turns

AuthRequires authentication via bearerAuth.

Description

Records a completed Turn from an existing Matter document.

Request

cURLJavaScriptPython

Copy

curl -X POST "https://api.redline.example/v1/matters/mat_01JAZ6Q7K2/turns" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "side": "counterparty",
  "document_id": "doc_01JAZ7C3V9",
  "summary": "Updated liability cap and renewal notice period.",
  "completed_by": "counterparty.legal@asterpeak.example"
}'

const response = await fetch("https://api.redline.example/v1/matters/mat_01JAZ6Q7K2/turns", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "side": "counterparty",
      "document_id": "doc_01JAZ7C3V9",
      "summary": "Updated liability cap and renewal notice period.",
      "completed_by": "counterparty.legal@asterpeak.example"
    }),
});

import requests

response = requests.post(
    "https://api.redline.example/v1/matters/mat_01JAZ6Q7K2/turns",
    headers={
      "Authorization": "Bearer YOUR_TOKEN"
    },
    json={
      "side": "counterparty",
      "document_id": "doc_01JAZ7C3V9",
      "summary": "Updated liability cap and renewal notice period.",
      "completed_by": "counterparty.legal@asterpeak.example"
    },
)

Response201JSONCopy

{
  "id": "trn_01JAZ7J8R5",
  "matter_id": "mat_01JAZ6Q7K2",
  "number": 3,
  "side": "workspace",
  "document_id": "doc_01JAZ7C3V9",
  "summary": "string",
  "completed_by": "string",
  "completed_at": "2024-01-01T00:00:00Z"
}

Parameters

matter_idpathstringrequired

Matter identifier.

Request body

application/jsonrequired

sidebodystringrequired

Party that completed the Turn.

document_idbodystringrequired

summarybodystring

completed_bybodystringrequired

Responses

201The recorded Turn.application/json

idstringrequired

matter_idstringrequired

numberintegerrequired

sidestringrequired

Party that completed the Turn.

document_idstringrequired

summarystring | null

completed_bystringrequired

Member identifier or verified counterparty email.

completed_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

404The resource was not found in the authenticated Workspace.application/json

errorobjectrequired

409The operation conflicts with the current resource state.application/json

errorobjectrequired

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

errorobjectrequired