Update Matter status

Your Company APIMatters

PATCHhttps://api.your-company.example/v1/matters/{matter_id}/status

AuthenticationRequires bearerAuth.

Description

Moves a Matter to a permitted lifecycle status.

Request

curl -X PATCH "https://api.your-company.example/v1/matters/mat_01JAZ6Q7K2/status" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "awaiting_approval",
  "reason": "Commercial terms agreed and ready for internal approval."
}'

const response = await fetch("https://api.your-company.example/v1/matters/mat_01JAZ6Q7K2/status", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "status": "awaiting_approval",
      "reason": "Commercial terms agreed and ready for internal approval."
    }),
});

import requests

response = requests.patch(
    "https://api.your-company.example/v1/matters/mat_01JAZ6Q7K2/status",
    headers={
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    json={
      "status": "awaiting_approval",
      "reason": "Commercial terms agreed and ready for internal approval."
    },
)

Response200JSON

{
  "id": "mat_01JAZ6Q7K2",
  "name": "Example Counterparty services agreement",
  "agreement_type": "Master services agreement",
  "counterparty_name": "Example Counterparty, Inc.",
  "status": "draft",
  "owner_id": "usr_01J9M4X8D2",
  "template_id": "tpl_01J8TR5A6P",
  "target_signature_date": "2026-08-28",
  "external_reference": "deal_84217",
  "current_turn_number": 3,
  "executed_copy_id": null,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Parameters

matter_idpathstringrequired

Matter identifier.

Request body

application/jsonrequired

statusstringrequired

Allowed values: draftnegotiatingawaiting_approvalready_for_signatureexecutedclosed

Current lifecycle state of a Matter.

reasonstring

Context recorded in Matter activity.

Responses

200The updated Matter.application/json

idstringrequired

Stable Matter identifier

namestringrequired

Human-readable Matter name

agreement_typestringrequired

Workspace-defined contract category

counterparty_namestringrequired

Other contracting party

statusstringrequired

Allowed values: draftnegotiatingawaiting_approvalready_for_signatureexecutedclosed

Current lifecycle state of a Matter.

owner_idstringrequired

Workspace member responsible for the Matter

template_idstring | null

Template used for the first draft

target_signature_datestring | null

Internal target for signature

external_referencestring | null

Identifier from a connected business system

current_turn_numberinteger

Latest completed Turn number

executed_copy_idstring | null

Final signed document when execution is complete

created_atstring <date-time>required

Creation timestamp.

updated_atstring <date-time>required

Most recent update timestamp.

Example response

{
  "id": "mat_01JAZ6Q7K2",
  "name": "Example Counterparty services agreement",
  "agreement_type": "Master services agreement",
  "counterparty_name": "Example Counterparty, Inc.",
  "status": "draft",
  "owner_id": "usr_01J9M4X8D2",
  "template_id": "tpl_01J8TR5A6P",
  "target_signature_date": "2026-08-28",
  "external_reference": "deal_84217",
  "current_turn_number": 3,
  "executed_copy_id": null,
  "created_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"
  }
}

404The resource was not found in the authenticated Workspace.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": "not_found",
    "message": "The requested resource was not found.",
    "request_id": "req_01JAZA0P8M"
  }
}

409The operation conflicts with the current resource state.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": "state_conflict",
    "message": "The Matter cannot move to the requested status.",
    "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"
      }
    ]
  }
}