Kartra Documentation TECHNICAL DOCUMENTATION

Action: Unsubscribe lead from a sequence

Unsubscribes lead to a specified sequence. Note that…

  1. The sequence must be already created in your account (https://app.kartra.com/communication/sequences).
  2. The lead must have been previously subscribed to that sequence. Otherwise, the command will be ignored.

 

Type Parameters Values
POST cmd* unsubscribe_lead_from_sequence
POST sequence_name* string

* Required fields

Here is an example:

'lead' => [
    'email' => 'example@email.com'
],
'actions' => [
    '0' => [
        'cmd' => 'unsubscribe_lead_from_sequence',
        'sequence_name' => 'Sequence name'
    ]
]

Success message:

{
  "status": "Success",
  "message": "The lead will be removed from sequence {sequence_name} in a few moments",
  "type": "108"
}

Error Cases:

Type Number Message Cause
226 sequence_name cannot be empty. Nothing done
  • ‘sequence_name’ parameter is mandatory and cannot be empty
220 Invalid sequence. Nothing done
  • The sequence is not in our database.

An example of an error message:

{
  "status": "Error",
  "message": "sequence_name cannot be empty. Nothing done",
  "type": "226"
}

© 2021 Kartra All Rights Reserved