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.
ExcludeFormattedValues string | null

If set to any value, formatted values will be excluded from the response.

Responses

201 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data array[object]
  
  Hide data attributes Show data attributes object
  
  TagGUID string(uuid)
  
  CompanyGUID string(uuid)
  
  TagName string
  
  TagColour string
  
  FormattedValues object
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
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
  
  TagGUID array[string]

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

curl \
 --request POST 'https://api.fincalc.co.uk/api/v2/clients/{ClientGUID}/tags' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"TagGUID":"9AF4C4F2-1F8D-4C6F-98A1-4C893EC8C8C8","ExcludeFormattedValues":1}'

Request examples

{
  "TagGUID": "9AF4C4F2-1F8D-4C6F-98A1-4C893EC8C8C8",
  "ExcludeFormattedValues": 1
}

Response examples (201)

{
  "success": true,
  "data": [
    {
      "TagGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "CompanyGUID": "72204219-8DFF-0F26-B66E-39C4F9DD5799",
      "TagName": "Accumulation",
      "TagColour": "#000FFF",
      "FormattedValues": {
        "CompanyGUID": "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."
    ]
  }
}