Skip to main content
PATCH
/
matters
/
{matterId}
/
layouts
/
{itemId}
Merge a layout
curl --request PATCH \
  --url https://api.smokeball.com/matters/{matterId}/layouts/{itemId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "itemId": "59791902-6280-471b-bd18-f8439ba3042f",
  "layoutDesignId": "414ab774-adce-4659-b18c-82d1b0e826a0",
  "index": 0,
  "parentItemId": "59791902-6280-471b-bd18-f8439ba3042f",
  "parentId": "Client",
  "parentIndex": 0,
  "name": "Item",
  "description": "Text describing item",
  "values": [
    {
      "key": "<string>",
      "value": "<string>",
      "state": "<unknown>"
    }
  ],
  "events": [
    {
      "id": "<string>",
      "appointmentId": "<string>"
    }
  ],
  "isRemoved": false
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
matterId
string<uuid>
required

Matter ID

​
itemId
string<uuid>
required

Matter item Id

Query Parameters

​
skipFieldValidation
boolean
default:false

Used to skip the field validation, may be needed for Smokeball data split migrations

Body

Data to merge into the existing layout

​
itemId
string | null

Unique identifier for the matter list item.

Example:

"59791902-6280-471b-bd18-f8439ba3042f"

​
layoutDesignId
string | null

Identifier of the layout design.

Example:

"414ab774-adce-4659-b18c-82d1b0e826a0"

​
index
integer<int32>

Zero-based index of the layout item.

Example:

0

​
parentItemId
string | null

Unique identifier for the parent matter list item.

Example:

"59791902-6280-471b-bd18-f8439ba3042f"

​
parentId
string | null

Identifier of the parent matter list item specific to the provider.

Example:

"Client"

​
parentIndex
integer<int32>

Zero-based index of the parent matter list item.

Example:

0

​
name
string | null

Name of the layout item.

Example:

"Item"

​
description
string | null

Brief description of the layout item.

Example:

"Text describing item"

​
values
object[] | null

List of layout values.

​
events
object[] | null

List of layout events.

​
isRemoved
boolean

Boolean flag indicating if the layout item is to be removed.

Example:

false

Response

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

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET