Add relationship to a role

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

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

Add relationship to a role

cURL

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
}
'

import requests

url = "https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships"

payload = {
    "name": "Provider",
    "displayName": "Medical Provider",
    "contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
    "representativeIds": ["776e778f-83df-454a-b344-768a862a7e67"],
    "isMatterItemRequired": True
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    name: 'Provider',
    displayName: 'Medical Provider',
    contactId: 'c85d28cb-a760-4627-aa59-0a853c2e65ed',
    representativeIds: ['776e778f-83df-454a-b344-768a862a7e67'],
    isMatterItemRequired: true
  })
};

fetch('https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Provider',
    'displayName' => 'Medical Provider',
    'contactId' => 'c85d28cb-a760-4627-aa59-0a853c2e65ed',
    'representativeIds' => [
        '776e778f-83df-454a-b344-768a862a7e67'
    ],
    'isMatterItemRequired' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships"

	payload := strings.NewReader("{\n  \"name\": \"Provider\",\n  \"displayName\": \"Medical Provider\",\n  \"contactId\": \"c85d28cb-a760-4627-aa59-0a853c2e65ed\",\n  \"representativeIds\": [\n    \"776e778f-83df-454a-b344-768a862a7e67\"\n  ],\n  \"isMatterItemRequired\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"name\": \"Provider\",\n  \"displayName\": \"Medical Provider\",\n  \"contactId\": \"c85d28cb-a760-4627-aa59-0a853c2e65ed\",\n  \"representativeIds\": [\n    \"776e778f-83df-454a-b344-768a862a7e67\"\n  ],\n  \"isMatterItemRequired\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"name\": \"Provider\",\n  \"displayName\": \"Medical Provider\",\n  \"contactId\": \"c85d28cb-a760-4627-aa59-0a853c2e65ed\",\n  \"representativeIds\": [\n    \"776e778f-83df-454a-b344-768a862a7e67\"\n  ],\n  \"isMatterItemRequired\": true\n}"

response = http.request(request)
puts response.read_body

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

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

application/json-patch+jsonapplication/jsonapplication/*+json

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

202

application/json

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