Skip to main content
PATCH
/
tags
/
{id}
Update a tag
curl --request PATCH \
  --url https://api.heffl.com/api/v2/tags/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "color": "<string>",
  "icon": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "color": "<string>",
  "icon": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

​
id
string
required

Tag ID

Body

application/json
​
name
string

Tag name

​
color
string

Tag color (hex)

​
icon
string | null

Tag icon

Response

OK

​
id
string
required

Tag ID

​
name
string
required

Tag name

​
color
string
required

Tag color (hex)

​
type
enum<string>
required

Entity type the tag applies to

Available options:
leads,
deals,
clients,
contacts,
projects,
project_tasks,
invoices,
quotations,
schedules,
fs_jobs,
purchase_orders,
vendors,
bills
​
icon
string | null

Tag icon