Skip to content

Update matter details

POST
/matters/{matterId}

This endpoint allows you to update matter details.

Parameters

Path Parameters

matterId
required
string

The ID of the matter to apply the update to

Request Body required

object
data
object
type
string
id
string
attributes
object
name

The name of the matter. This is a required field.

string
description

The description of the matter. This is an optional field.

string
external-reference

An external reference for the matter, such as a case number or external ID. This is an optional field.

object
id

The external reference ID

string
source

The source of the external reference

string

Responses

200

Matter roles updated

object
data
object
type
string
id
string
attributes
object
name

Name of the matter

string
description

Description of the matter

string
external-reference
object
id

External reference for the matter

string
source

Source of the external reference

string
tags

A list of label/value tags associated with the matter as an array of object .

Array<object>
object
label

The label of the tag (e.g., “priority”, “status”, “type”, “value”)

string
value

An optional value to the label of the tag (e.g., “high”, “open”, “ACC”, “$3,000”)

string
types

A list of matter type identifiers for this matter

Array<string>
jurisdictions
Array<string>
roles

A list of roles and users associated with the matter

If no OWNER is specified, the current user will be set as the matter owner

object
OWNER

Matter owner (limited to one user)

Array<string>
LEAD

Matter lead (limited to one user)

Array<string>
BUSINESS_1

Business Administrators of the matter

Array<string>
ADVOCATE_1

Advocates (or Barristers) of the matter

Array<string>
CONSULTANT_1

Consultants of the matter

Array<string>
LEGAL_1

Senior Lawyers of the matter

Array<string>
LEGAL_2

Junior Lawyers of the matter

Array<string>
LEGAL_3

Law Clerks or Paralegals of the matter

Array<string>
ADMINISTRATIVE_1

Senior Legal Assistants of the matter

Array<string>
ADMINISTRATIVE_2

Junior Legal Assistants of the matter

Array<string>
relationships
object
milestones
object
data
Array<object>
object
type
string
id
string
included
Array<object>
object
type
string
id
string
attributes
object
name

Name of the milestone

string
description

Description of the milestone

string
status

Status of the milestone

string
Allowed values: NOTSTARTED INPROGRESS DONE
created-date

An integer representing milliseconds since the Unix epoch

integer format: int64
due-date

An integer representing milliseconds since the Unix epoch

integer format: int64
target-date

An integer representing milliseconds since the Unix epoch

integer format: int64
total-tasks

Total number of tasks in the milestone

integer
completed-tasks

Number of completed tasks in the milestone

integer
pending-tasks

Number of pending tasks in the milestone

integer