Skip to main content
DELETE
/
matters
/
{matterId}
/
tags
/
{tagId}
Remove tags from a matter
curl --request DELETE \
  --url https://api.smokeball.com/matters/{matterId}/tags/{tagId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
[
  {
    "id": "<string>",
    "name": "<string>",
    "color": "<string>",
    "type": "Staff"
  }
]
'
{
  "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
​
tagId
string<uuid>
required

Body

​
id
string | null

Unique identifier for the tag.

When the tag Type is Staff, this value represents the staff member's ID.

When GET tags, this value represents the tag's unique identifier after creation.

Not required when posting standard custom tags.

​
name
string | null

Human-readable display name of the tag.

API would know you are adding the same tag to multiple matters as long as they have the same Name.

You can put any string you like and you can re-use strings as they are stored and re-used per account.

Theoretically an Id would be the same across matters for a custom tag.

​
color
string | null

Visual color associated with the tag.

Must be one of the supported color values (the valid list is documented separately).

If not provided, the color will default to Brown.

If the tag already exists, this field will be ignored and the existing color will be retained.

​
type
string

Defines what kind of tag this is.

Accepted values:

Staff – The tag represents a firm staff member.

Custom – The tag is a user-defined custom label.

Example:

"Staff"

Response

When request is accepted. Returns a 'Link' object.

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