Kartra Documentation Technical Documentation for Kartra

Action: Unassign tag from a lead

Deletes a tag from the specified lead. Note that…

  1. The tag must have been already created from within your Kartra account (https://app.kartra.com/communication/tags).
  2. The lead must have been previously tagged with that tag. Otherwise, the command will be ignored.


Type Parameters Values
POST cmd* unassign_tag
POST tag_name* string

* Required fields

Here is an example:

'lead' => [
    'email' => 'example@email.com'
'actions' => [
    '0' => [
        'cmd' => 'unassign_tag',
        'tag_name' => 'tag name'

Success message:

  "status": "Success",
  "message": "Tag removed from lead",
  "type": "104"

Error Cases:

Type Number Message Cause
213 Tag cannot be empty
  • ‘tag_name’ parameter it is mandatory and cannot be empty.
214 Tag does not exist
  • The tag is not in our database.

An example of an error message:

  "status": "Error",
  "message": "Tag does not exist",
  "type": "214"
Was this article helpful?

© 2024 Kartra All Rights Reserved