Skip to main content
POST
/
matters
/
{matterId}
/
roles
/
{roleId}
/
relationships
Add relationship to a role
curl --request POST \
  --url https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Provider",
  "displayName": "Medical Provider",
  "contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "representativeIds": [
    "776e778f-83df-454a-b344-768a862a7e67"
  ],
  "isMatterItemRequired": true
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Headers

ā€‹
Version
integer<int32>

Path Parameters

ā€‹
matterId
string<uuid>
required
ā€‹
roleId
string<uuid>
required

Body

ā€‹
name
string | null

Name of the relationship.

Example:

"Provider"

ā€‹
displayName
string | null

Display Name of the relationship.

Example:

"Medical Provider"

ā€‹
contactId
string | null

Unique identifier of the contact.

Example:

"c85d28cb-a760-4627-aa59-0a853c2e65ed"

ā€‹
representativeIds
string[] | null

List of associated representative contact ids.

Example:
["776e778f-83df-454a-b344-768a862a7e67"]
ā€‹
isMatterItemRequired
boolean

Boolean flag indicating if a matter item is required.

Response

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

ā€‹
id
string | null
ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET