Kartra Documentation Technical Documentation for Kartra

Action: Subscribe a lead to a list

This will allow you to subscribe a lead to any specific mailing list. Note that you must have previously created your list within your Kartra account (https://app.kartra.com/communication/lists).

The API call will fail if it doesn’t find the specified list within your Kartra account.


Type Parameters Values
POST cmd* subscribe_lead_to_list
POST list_name* string

* Required fields

Here is an example:

'lead' => [
    'email' => 'example@email.com'
'actions' => [
    '0' => [
        'cmd' => 'subscribe_lead_to_list',
        'list_name' => 'List name'

Success message:

  "status": "Success",
  "message": "Lead subscribed to list",
  "type": "101"

Error Cases:

Type Number Message Cause
207 List cannot be empty
  • ‘list_name’ parameter it is mandatory and cannot be empty.
231 List does not exist
  • The list is not in our database.

An example of an error message:

  "status": "Error",
  "message": "List cannot be empty",
  "type": "207"
Was this article helpful?

© 2024 Kartra All Rights Reserved