Add client tag to client

POST /api/v2/clients/{ClientGUID}/tags
Bearer auth

This endpoint allows users to add a company client tag to a specified client.

Path parameters

  • ClientGUID string(uuid) Required

    The GUID of the client you want to add the client tag to.

application/json

Body

  • TagGUID string(uuid) Required

    The GUID of the client tag you want to add to the client.

Responses

  • 201 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.

      Hide data attribute Show data attribute object
POST /api/v2/clients/{ClientGUID}/tags 
curl \
 -X POST https://api.fincalc.co.uk/api/v2/clients/{ClientGUID}/tags \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"TagGUID":"9AF4C4F2-1F8D-4C6F-98A1-4C893EC8C8C8"}'
Request examples 
{
  "TagGUID": "9AF4C4F2-1F8D-4C6F-98A1-4C893EC8C8C8"
}
Response examples (201) 
{
  "success": true,
  "data": [
    {
      "TagGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "CompanyID": 2,
      "TagName": "Accumulation",
      "TagColour": "#000FFF",
      "FormattedValues": {
        "CompanyID": "FinCalc"
      }
    }
  ]
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to edit that client."
}
Response examples (422) 
{
  "success": false,
  "message": "Validation Error",
  "data": {
    "TagGUID": [
      "The tag guid field is required."
    ]
  }
}