Kartra API: Inbound > Actions. This article is for developers.

Assigns a tag to a specified lead. Note that the tag must already exist in your Kartra account.

TypeParametersValues
POSTcmd*assign_tag
POSTtag_name*string

* Required fields

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 NumberMessageCause
211Tag cannot be empty
  • 'tag_name' parameter it is mandatory and cannot be empty.
212Tag does not exist
  • The tag is not in our database.
Error message example
{
  "status": "Error",
  "message": "Tag cannot be empty",
  "type": "211"
}