Unsubscribes lead to a specified sequence. Note that...
The sequence must be already created in your account (https://app.kartra.com/communication/sequences).
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' => '[email protected]'
],
'actions' => [
'0' => [
'cmd' => 'unsubscribe_lead_from_sequence',
'sequence_name' => 'Sequence name'
]
]Success message:
{
"status": "Success",
"message": "Lead removed from sequence",
"type": "108"
}Error Cases:
Type Number | Message | Cause |
226 | Sequence cannot be empty |
|
220 | Sequence does not exist |
|
An example of an error message:
{
"status": "Error",
"message": "Sequence cannot be empty",
"type": "226"
}