Variable | Type | Description |
---|
list_id | string|int | The ID of the list in which to save the subscription |
email | string | The email of the subscriber |
firstname | string|null | The firstname of the subscriber, can be null. |
lastname | string|null | The lastname of the subscriber, can be null. |
ip | string | The ip address of the subscriber |
props | struct|null | Hash array with props (can be later used to build segment criteria) |
options | struct|null | Hash array with options for this init subscribe. Valid keys are:- segments: array with segment ids where user will be added
- template_id: string with the ID of the template used for sending out the confirmation email. Templates are created through the template API.
- form_id: string with the ID of the form used for confirmation email and form settings. Forms are created in the admin.
- check_already_subscribed: Check if the subscriber is already subscribed in the list.
|
Code |
Message |
Description |
407 |
Missing required param list_id |
list_id param is required |
407 |
Missing required param email |
email param is required |
407 |
Missing required param firstname |
firstname param is required |
407 |
Missing required param lastname |
lastname param is required |
407 |
Missing required param ip |
ip param is required |
407 |
Missing required param props |
props param is required |
407 |
Missing required param options |
options param is required |
101 |
Not allowed for list_id = %s |
Invalid access to subscriber list_id |
108 |
List %s has been deleted |
List ID belongs to a list which has been deleted |
122 |
Invalid IP received $ip |
The IP is invalid |
126 |
Optout email received %s |
Optout email. Only initsubscribe is allowed. |
123 |
Invalid email address %s. |
The email is not valid |
10001 |
Cannot use both template_id and form_id |
Cannot use both template_id and form_id in options |
128 |
Too many requests for this subscriber. Can only send once per 10 minutes |
Can only send once per 10 minutes to the same email |
144 |
Cannot subscribe to this segment |
Cannot subscribe to this segment |
201 |
Internal Error: %s |
A database error occurred |