Kartra Documentation TECHNICAL DOCUMENTATION

Action: Assign tag to a lead

Assigns a tag to a specified lead. Note that you must have previously created the tag in your Kartra account (https://app.kartra.com/communication/tags).

 

Type Parameters Values
POST cmd* assign_tag
POST tag_name* string

* Required fields

Here is an example:

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

Success message:

{
  "status": "Success",
  "message": "Tag added to lead",
  "type": "103"
}

Error Cases:

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

An example of an error message:

{
  "status": "Error",
  "message": "Tag cannot be empty",
  "type": "211"
}

© 2021 Kartra All Rights Reserved