Kartra Documentation TECHNICAL DOCUMENTATION

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": "The tag {tag_name} will be removed from lead in a few moments",
  "type": "104"
}

Error Cases:

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

An example of an error message:

{
  "status": "Error",
  "message": "Invalid tag. Nothing done",
  "type": "214"
}

© 2021 Kartra All Rights Reserved