Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Relationships

Update a relationship

Updates a specified relationship on a matter.

put/matters/{matterId}/roles/{roleId}/relationships/{id}

Path parameters

matterIdstring uuid required
roleIdstring uuid required
idstring uuid required

Request body

namestring nullable

Name of the relationship.

displayNamestring nullable

Display Name of the relationship.

contactIdstring nullable

Unique identifier of the contact.

representativeIdsstring[] nullable

List of associated representative contact ids.

isMatterItemRequiredboolean

Boolean flag indicating if a matter item is required.

Example request

{
  "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 relationship to be updated.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable