Add tags to company You can provide an array of tags in various formats.

POST /api/v1/tag

Personal access token & O auth2

Each element in the array can be:

a string of the tag name (and it will find it if it exists for the firm)
a UUID of a tag that already exists
an array of a name value and a colour value. e.g. ['name' => 'Urgent', 'colour' => '#FF0000']

There are four different modes for dealing with tags on a model.

create = Create the tags you provide with no model attached to them.
attach = Add the tags you provide to the model, keeping any tags already on the model.
sync = Only the tags you provide in the request should exist on the model, this will remove any that you have not provided.
detach = Remove the tags you provide from the model.

application/json

Body Required

mode string Required

Mode for dealing with tags. Valid modes are: attach|sync|detach|create. Attach will add the tags to the model, sync will remove all other tags and add the ones provided, detach will remove the tags from the model, create will create the tags without attaching them to a model.
taggable_type string Required

Model type to assign these tags to. Valid types are: account, board, board_task, case, conversation, file, note, plan
taggable_uuid string Required

Model UUID to assign these tags to.
tags array[string] Required

Tags can be provided in various formats. If you do not provide a colour a random one will be chosen for you.

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  colour string

POST /api/v1/tag

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/tag' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"mode":"attach","taggable_type":"message","taggable_uuid":"8b22874f-0323-49f3-a009-c1025f6023c7","tags":["Reviewed",null,{"name":"Urgent","colour":"#FF0000"}]}'

Request examples

{
  "mode": "attach",
  "taggable_type": "message",
  "taggable_uuid": "8b22874f-0323-49f3-a009-c1025f6023c7",
  "tags": [
    "Reviewed",
    null,
    {
      "name": "Urgent",
      "colour": "#FF0000"
    }
  ]
}

Response examples (200)

{
  "data": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "afd5a915-a3db-4601-8469-3993c8a5a31f",
      "colour": "#ef4582",
      "created_at": "2025-06-26T11:37:06+01:00",
      "updated_at": "2025-06-26T11:37:06+01:00"
    }
  ]
}