Subscribers collection allows adding new subscribers using HTTP POST method. If subscriber you want to add is already present (subscribers have unique emails and unique phone numbers), they are updated.<\/p>\n\n\n\n
It is possible to add a single subscriber or multiple subscribers with one request.<\/p>\n\n\n\n
Please note that you should not add\/update more then 100 subscribers using a single API call.<\/p>\n\n\n\n
For this method, all request data should be provided in XML or JSON format. Responses, depending on the format provided, are also generated as XML or JSON data.<\/p>\n\n\n\n
The content type for such a request should be set to text\/xml or application\/json.<\/p>\n\n\n\n
ApiRequest element children:<\/p>\n\n\n\n Data element children:<\/p>\n\n\n\n * Please note that for adding new subscribers providing Email is required. If you want to update a particular subscriber you should provide only one of Email, EmailMd5 or EmailSha256. If you want to change Email address for a subscriber you have to provide BOTH Email and Id fields. WARNING! <\/strong>Please note that each phone number must include country prefix. Except digits it is allowed to enter a plus sign “+”, left and right parenthesis “(” “)” or zeros. Regardless of the input the phone number will be saved as an integer that is less than or equal to 20 characters. Here’s how sample, valid input numbers will be saved in the database:<\/p>\n\n\n\n Supported adding modes:<\/p>\n\n\n\nParameter<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> ApiKey<\/td> string<\/td> Your API key. Required for authentication.<\/td><\/tr> ReturnData<\/td> boolean<\/td> If set to “true” (note the lowercase!), additional information will be returned for each added subscriber. Especially useful with MultiData.<\/td><\/tr> VerboseErrors<\/td> boolean<\/td> If set to \u201ctrue\u201d (note the lowercase!), errors will be returned in verbose way. See examples.<\/td><\/tr> Data<\/td> complex<\/td> Object containing subscriber information. Required, unless you are adding multiple subscribers using MultiData element instead.<\/td><\/tr> MultiData<\/td> complex<\/td> Object containing multiple subscribers information for adding subscribers in batches. Required, unless you are adding a single subscriber using Data element.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Request data format<\/strong><\/h3>\n\n\n\n
Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> xsi:type<\/td> –<\/td> Describes type of manipulated data. Value should always be \u201cSubscriber\u201d for this request<\/td><\/tr> Mode<\/td> string<\/td> Adding mode. See below for list of supported modes.
Optional. Defaults to \u201cAddAndUpdate\u201d<\/td><\/tr>Force<\/td> boolean<\/td> If set to \u201ctrue\u201d (note the lowercase!), this parameter will force sending another confirmation email to subscriber.
Applies only to Double Opt-In lists and non-confirmed subscribers.
Optional. Defaults to \u201cfalse\u201d.<\/td><\/tr>ListId<\/td> integer<\/td> Identifier of list the subscriber is added to.
Required.<\/td><\/tr>AllowUnsubscribed<\/td> boolean<\/td> If set to “false” (note the lowercase!), the system will not allow adding subscribers that previously unsubscribed from the system. Default is “true”.<\/td><\/tr> AllowRemoved<\/td> boolean<\/td> If set to “false” (note the lowercase!), the system will not allow adding subscribers that were previously removed from the system by the user. Default is “true”.<\/td><\/tr> MatchingMode<\/td> string<\/td> Subscriber’s matching mode. This field will be used as a primary identifier of a subscriber. Optional. Possible values: Email, CustomSubscriberId, Id, Phone (Phone is available only if unit has access to SMS channel). By default Email value is used when providing only Email, or Phone and Email. By default Phone value is used when providing only Phone. By default Id value is used when providing Id.<\/td><\/tr> Id<\/td> integer<\/td> Subscriber\u2019s unique identifier. Optional. * Read note below this table<\/td><\/tr> Email<\/td> string<\/td> Subscriber\u2019s email. Optional. * Read note below this table<\/td><\/tr> EmailMd5<\/td> string<\/td> Subscriber’s MD5. Optional. * Read note below this table<\/td><\/tr> EmailSha256<\/td> string<\/td> Subscriber’s SHA256. Optional. * Read note below this table<\/td><\/tr> Phone<\/td> string<\/td> Subscriber\u2019s phone number (available only if unit has access to SMS channel). Optional. ** Read note below this table<\/td><\/tr> CustomSubscriberId<\/td> string<\/td> Subscriber’s custom ID. Optional.<\/td><\/tr> CustomChannelId<\/td> string<\/td> Subscriber’s custom channel ID. Max 256 char. Optional.***<\/td><\/tr> Firstname<\/td> string<\/td> Subscriber\u2019s firstname. Optional.<\/td><\/tr> Lastname<\/td> string<\/td> Subscriber\u2019s lastname. Optional.<\/td><\/tr> TrackingCode<\/td> string<\/td> Identifier of source of subscriber (e.g. particular webform on a webpage). Optional.<\/td><\/tr> Name<\/td> string<\/td> Full name. Can be used when separate data for firstname and lastname is not available. It will be matched against following template: \u201cFirstname Lastname\u201d.<\/td><\/tr> Vendor<\/td> string<\/td> Identifier\/name of traffic vendor the subscriber came from. Optional.<\/td><\/tr> Ip<\/td> string<\/td> IP address of subscriber. Optional.<\/td><\/tr> Properties<\/td> complex<\/td> Collection of custom subscriber properties (Property elements). Optional.<\/td><\/tr> SpamDecoy<\/td> string<\/td> A special field used to detect spam bots that automatically fill webforms. If you detect a spam bot on your website, you may fill this field with spam content, so it is saved for further analysis and reporting purposes.
WARNING!<\/strong> If this field is filled, subscriber will NOT be added to database! Only an attempt will be registered and appropriate error code returned. Do NOT<\/strong> fill this field if you are adding regular subscribers. <\/td><\/tr>DisableConfirmationEmail<\/td> boolean<\/td> If it is “true” the subscriber will be added to the double opt-in list without email confirmation. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
** If you have SMS channel activated it is possible to provide either Email or Phone number for adding new subscribers. (If you want to update a particular subscriber you should provide only one of Email, EmailMd5, EmailSha256, Phone. If you want to change Email or Phone you should provide one of Email, EmailMd5, EmailSha256, Phone, Id, CustomSubscriberId AND Email or Phone that you want to change.).
***Only when custom channel is enabled.\u00a0Adding a value to this field will subscribe user to a new channel \u2013 custom<\/p>\n\n\n\n\n