Action: Subscribe lead to a sequence
Subscribes a lead to a specified sequence, at a particular step within the sequence. That step is defined by the step’s box number.
Note that the sequence and the step number must be already created in your account (https://app.kartra.com/communication/sequences).
Type | Parameters | Values |
POST | cmd* | subscribe_lead_to_sequence_at_step |
POST | sequence_name* | string |
POST | step* | string |
* Required fields
Here is an example:
'lead' => [ 'email' => 'example@email.com' ], 'actions' => [ '0' => [ 'cmd' => 'subscribe_lead_to_sequence_at_step', 'sequence_name' => 'Sequence name', 'step' => '1' ] ]
Success message:
{ "status": "Success", "message": "The lead will be added to sequence {sequence_name} in a few moments", "type": "107" }
Error Cases:
Type Number | Message | Cause |
226 | sequence_name cannot be empty. Nothing done |
|
225 | step cannot be empty. Nothing done |
|
219 | Invalid sequence. Nothing done |
|
229 | step has to be alphanumeric. Nothing done |
|
230 | step does not exist. Nothing done |
|
An example of an error message:
{ "status": "Error", "message": "sequence_name cannot be empty. Nothing done", "type": "226" }