v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Relationships

Add relationship to a role

Appends a new relationship with an existing role in the specified matter.

post/matters/{matterId}/roles/{roleId}/relationships

Path parameters

matterIdstring uuid required

roleIdstring uuid required

Headers

Versioninteger

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 created.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable