Kartra Documentation TECHNICAL DOCUMENTATION

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": "Lead added to sequence",
  "type": "107"
}

Error Cases:

Type Number Message Cause
226 Sequence cannot be empty
  • sequence_name parameter is mandatory and cannot be empty.
225 Step cannot be empty
  • step parameter is mandatory and cannot be empty.
219 Sequence does not exist
  • The sequence is not in our database.
229 Step has to be alphanumeric
  • step parameter needs to have alphanumeric characters.
230 Step does not exist
  • The sequence step was not found in our database.

An example of an error message:

{
  "status": "Error",
  "message": "Sequence cannot be empty",
  "type": "226"
}

© 2021 Kartra All Rights Reserved