Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Roles

Add role to a matter

Appends a new role in the specified matter.

post/matters/{matterId}/roles

Path parameters

matterIdstring uuid required

Headers

Versioninteger

Request body

namestring nullable

Name of the role.

displayNamestring nullable

Display Name of the role.

descriptionstring nullable

Description of the role.

contactIdstring nullable

Unique identifier of the contact.

representativeIdsstring[] nullable

List of associated representative contact ids.

isMatterItemRequiredboolean

Boolean flag indicating if matter item is required.

Example request

{
  "name": "Provider",
  "displayName": "Medical Provider",
  "description": "Client",
  "contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "representativeIds": [
    "776e778f-83df-454a-b344-768a862a7e67"
  ],
  "relationships": [
    {
      "name": "Provider",
      "displayName": "Medical Provider",
      "contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
      "representativeIds": [
        "776e778f-83df-454a-b344-768a862a7e67"
      ]
    }
  ]
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the role to be created.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable