Update client tag

PUT /api/v2/companysettings/clienttags/{TagGUID}
Bearer auth

This endpoint allows users to update a company client tag.

Path parameters

  • TagGUID string(uuid) Required

    The GUID of the client tag to update.

application/json

Body

  • TagName string Required

    The name of the client tag.

    Maximum length is 25.

  • TagColour string Required

    It must be in the format # followed by exactly 6 hexadecimal digits (e.g. #1a2b3c).

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
  • 422 application/json

    Validation error.

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
    • data object

      Example validation error message.

      Additional properties are allowed.

      Hide data attribute Show data attribute object
PUT /api/v2/companysettings/clienttags/{TagGUID} 
curl \
 -X PUT https://api.fincalc.co.uk/api/v2/companysettings/clienttags/{TagGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"TagName":"Accumulation","TagColour":"#000FFF"}'
Request examples 
{
  "TagName": "Accumulation",
  "TagColour": "#000FFF"
}
Response examples (200) 
{
  "success": true,
  "data": {
    "TagGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
    "CompanyID": 2,
    "TagName": "Accumulation",
    "TagColour": "#000FFF",
    "TotalUsingTag": 14,
    "FormattedValues": {
      "CompanyID": "FinCalc"
    }
  }
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to update company client tags."
}
Response examples (422) 
{
  "success": false,
  "message": "Validation Error",
  "data": {
    "TagName": [
      "The tag name field is required."
    ]
  }
}