Skip to main content
PUT
/
matters
/
{matterId}
/
roles
/
{id}
Update role on a matter
curl --request PUT \
  --url https://api.smokeball.com/matters/{matterId}/roles/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Provider",
  "displayName": "Medical Provider",
  "description": "Client",
  "contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "representativeIds": [
    "776e778f-83df-454a-b344-768a862a7e67"
  ],
  "isMatterItemRequired": true,
  "relationships": [
    {
      "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/{id}"

payload = {
    "name": "Provider",
    "displayName": "Medical Provider",
    "description": "Client",
    "contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
    "representativeIds": ["776e778f-83df-454a-b344-768a862a7e67"],
    "isMatterItemRequired": True,
    "relationships": [
        {
            "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.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    name: 'Provider',
    displayName: 'Medical Provider',
    description: 'Client',
    contactId: 'c85d28cb-a760-4627-aa59-0a853c2e65ed',
    representativeIds: ['776e778f-83df-454a-b344-768a862a7e67'],
    isMatterItemRequired: true,
    relationships: [
      {
        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/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Provider',
    'displayName' => 'Medical Provider',
    'description' => 'Client',
    'contactId' => 'c85d28cb-a760-4627-aa59-0a853c2e65ed',
    'representativeIds' => [
        '776e778f-83df-454a-b344-768a862a7e67'
    ],
    'isMatterItemRequired' => true,
    'relationships' => [
        [
                '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/{id}"

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

	req, _ := http.NewRequest("PUT", 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.put("https://api.smokeball.com/matters/{matterId}/roles/{id}")
  .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  \"description\": \"Client\",\n  \"contactId\": \"c85d28cb-a760-4627-aa59-0a853c2e65ed\",\n  \"representativeIds\": [\n    \"776e778f-83df-454a-b344-768a862a7e67\"\n  ],\n  \"isMatterItemRequired\": true,\n  \"relationships\": [\n    {\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    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.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  \"description\": \"Client\",\n  \"contactId\": \"c85d28cb-a760-4627-aa59-0a853c2e65ed\",\n  \"representativeIds\": [\n    \"776e778f-83df-454a-b344-768a862a7e67\"\n  ],\n  \"isMatterItemRequired\": true,\n  \"relationships\": [\n    {\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    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

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

Path Parameters

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

Body

ā€‹
name
string | null

Name of the role.

Example:

"Provider"

ā€‹
displayName
string | null

Display Name of the role.

Example:

"Medical Provider"

ā€‹
description
string | null

Description of the role.

Example:

"Client"

ā€‹
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 matter item is required.

ā€‹
relationships
object[] | null

List if relationships associated with the role.

Response

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

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