inwise - email marketing and newsletter software company
 
inwise Top Background
Arrow on Service

Recipients Sign Up Recipient
Footer

Recipients Sign Up Recipient

Operation Name: operation Name
Description: description

All actions require a valid user name and password using authenticaion header.
Show a raw xml example including the authentication header.

Service url:https://api.inwise.com/InwiseWebServices.asmx

Adding a reference to inwise web services

User Name:
Password:  
Email :
Double Opt In :
Groups ID (separate with ',') :
Send Mail For New Recipient:
Send Mail For Existing Recipient:
Url For Email Body To Send After New Registration :
Url For Browser Text After New Registration :
Email Subject For New Recipient:
Url For Email Body To Send After Existing Registration :
Url For Browser Text After Existing Registration :
Email Subject For Existing Recipient
Update Details For Existing Recipient:
Charset :
Recipient Fields Values :
field1
field2
field3
field4
field5
field6
field7
field8
field9
field10
field11
field12
field13
field14
field15
field16
field17
field18
field19
field20
field21
field22
field23
field24
field25
field26
field27
field28
field29
field30
The service enables you to register a new recipient using by mocking the web registraion form logic.
The text returned by the service is the text the recipient would have seen on his/her browser if they were to use the web registraion form produced by our system. If the recipient should have been redirected to another url, the returned text will be the target url.

Parameters:

  • boolean doubleoptin
    Wait for confirmation email from the recipient?
    Setting the value to true will send the recipient confirmation email, and only after clicking the approval link on the email the registraion will be completed.
  • string email
    The new recipient email. This value must be filled. If the email is invalid an exception will be thrown.
  • Array groups
    The group for subscribing the recipient. This is array with the groups ids you want to add the recipient to. The values must be numerical and must be your groups.
    If no value is entered the recipient will be registered but will appear on no group.
  • boolean sendNewEmail
    Should an email be sent to the new recipient after the registraion for notification/greeting him/her for the registration?
  • boolean sendExistingEmail
    Should an email be sent to the existing recipient after a repeated registraion for notification/greeting ?
  • String emailBodyToSendAfterNewRegistrationUrl
    If you have selected to send the new recipient a notification/greeting email after a new registration, this value is the url from which the email body will be retrieved.
    If no url is entered the body will be the one defined by you on our systems.
    This value is optional and can be set to null;
  • String browserTextAfterNewRegistrationUrl
    The text to display on the browser for a new recipient after the registration.
    This value is optional and can be set to null.
    If no value is set the text will be the one defined by you on our systems under the config name "regist_browser_after_new_registration".
  • String emailBodyToSendAfterExistRegistrationUrl
    If you have selected to send the existing recipient a notification/greeting email after a repeated registration, this value is the url from which the email body will be retrieved.
    If no url is entered the body will be the one defined by you on our systems under the config name "regist_browser_after_new_registration".
    This value is optional and can be set to null;
  • String browserTextAfterExistRegistrationUrl
    The text to display on the browser for an existing  recipient after a repeated registration.
    This value is optional and can be set to null.
    If no value is set the text will be the one defined by you on our systems.
  • String charset
    The after registraion email charset.
    The value must a legal charset as defined by IANA
    This value is optional and can be set to null, in that case, the value will be the one defined by you on our systems.
  • String subjectForExising
    If you have selected to send the existing recipient a notification/greeting email after a repeated registration, this value is the subject for that email.
    This value is optional and can be set to null.
    If no value is set the text will be the one defined by you on our systems.
  • String subjectForNew
    If you have selected to send the new recipient a notification/greeting email after a new registration, this value is the subject for that email.
    This value is optional and can be set to null.
    If no value is set the text will be the one defined by you on our systems.
  • boolean update
    If the email already exists, should we update the recipient's details with the new details?
  • InwiseWebServices.CustomFieldValue[] fields;
    An array with custom fields values for the new recipient.
    The fields contain mapping of the recipient information to the local fields on our system.
    For example, if you have defined on our system that "field1" is the recipient first name, and you want to set the value for the new recipient, add a new CustomFieldValue with the LocalName set to "field1" and the FieldValue set to the recipient's first name.
    This field is optional and can set to null or 0 length array.

Java Code:

//get a reference to the service InwiseWebServices ws = new InwiseWebServices();
InwiseWebServicesSoap inwiseWebServicesSoap = ws.getInwiseWebServicesSoap();

//fill the security header
HeaderHandler hh = new HeaderHandler("myusername", "myPassword");
hh.setHeader(inwiseWebServicesSoap);

//fill the security header
HeaderHandler hh = new HeaderHandler("myusername", "myPassword");
hh.setHeader(inwiseWebServicesSoap);
//the new recipient email
String email = "[email protected]";

//wait for confirmation email from the recipient?
boolean doubleOptIn = false;

//send the new recipient a thank you email
boolean sendNewEmail = true;

//the body of the thank you email for a new recipient
String emailBodyToSendAfterNewRegistrationUrl = null;

//the text to display on the browser for a new recipient
String browserTextAfterNewRegistrationUrl = null;

//the body of the thank you email for an exisiting recipient
String emailBodyToSendAfterExistRegistrationUrl = null;

//the text to display on the browser for an existing recipient
String browserTextAfterExistRegistrationUrl = null;

//the text to display on the browser for an existing recipient
String charset = "utf-8";

//the thank you email subject for an existing recipient
String subjectForExising = null;

//the thank you email subject for a new recipient
String subjectForNew = null;

//if the email already exists, update the details?
boolean update = false;

//send email for an existing recipient
boolean sendExistingEmail = true;

//the custom fields values
inwise.ArrayOfCustomFieldValue fields = new ArrayOfCustomFieldValue();
fields.customFieldValue = new ArrayList<CustomFieldValue>();

CustomFieldValue field1 = new CustomFieldValue();
field1.setLocalName("field1");
field1.setFieldValue("my first name");
fields.customFieldValue.add(field1);

//the groups to subscribe to
inwise.ArrayOfAnyType groups = new ArrayOfAnyType();
groups.anyType = new ArrayList<Object>();
groups.anyType.add(34);
groups.anyType.add(158);

String result = inwiseWebServicesSoap.recipientsSignUpRecipient(email, doubleOptIn,
fields, groups, sendNewEmail, emailBodyToSendAfterNewRegistrationUrl,
browserTextAfterNewRegistrationUrl, emailBodyToSendAfterExistRegistrationUrl,
browserTextAfterExistRegistrationUrl, charset,
subjectForExising, subjectForNew, update, sendExistingEmail);

C# Code:

 InwiseWebServices.InwiseWebServices ws = new InwiseWebServices.InwiseWebServices();

 

        //fill the security header

        InwiseWebServices.SecHeader header = new InwiseWebServices.SecHeader();

        header.username = "myUsername";

        header.pass = "myPassword";

        ws.SecHeaderValue = header;//set credentials

 

        //wait for confirmation email from the recipient?

        bool doubleoptin = false;

 

        //the new recipient email

        string email = "[email protected]";

 

        //the group to subscribe to

        ArrayList groups =new ArrayList();

        groups.Add(8152);

        groups.Add(8823);

 

        //send the new recipient a thank you email

        bool sendNewEmail = false;

 

        //the body of the thank you email for a new recipient

        string emailBodyToSendAfterNewRegistrationUrl = null;

 

        //the text to display on the browser for a new recipient

        string browserTextAfterNewRegistrationUrl = null;

 

        //the body of the thank you email for an exisiting recipient

        string emailBodyToSendAfterExistRegistrationUrl = null;

 

        //the text to display on the browser for an existing recipient

        string browserTextAfterExistRegistrationUrl = null;

 

        //the email charset

        string charset = "utf-8";

 

        //the thank you email subject for an existing recipient

        string subjectForExising = null;

 

        //the thank you email subject for a new recipient

        string subjectForNew = null;

 

        //if the email already exists, update the details?

        bool update = true;

 

        //send email for an existing recipient

        bool sendExistingEmail = false;

 

        //the custom fields values

        InwiseWebServices.CustomFieldValue[] fields = null;

 

        string browserTextOrRedirectUrl = ws.Recipients_SignUpRecipient(email, doubleoptin, fields, groups, sendNewEmail, emailBodyToSendAfterNewRegistrationUrl, browserTextAfterNewRegistrationUrl, emailBodyToSendAfterExistRegistrationUrl, browserTextAfterExistRegistrationUrl, charset, subjectForExising, subjectForNew, update, sendExistingEmail);

VB Code:

 Dim ws As InwiseWebServices.InwiseWebServices = New InwiseWebServices.InwiseWebServices()

 

        'fill the security header

        Dim sec As InwiseWebServices.SecHeader = New InwiseWebServices.SecHeader()

 

        sec.username = "username"

        sec.pass = "myPassword"

        ws.SecHeaderValue = sec 'set credentials

 

        'wait for confirmation email from the recipient?

        Dim doubleoptin As Boolean = False

 

        'the new recipient email

        Dim email As String = "[email protected]"

 

        'the group to subscribe to

        Dim groups As Object = New Object(2) {}

 

        groups(0) = 8152

        groups(1) = 8823

 

        'send the new recipient a thank you email

        Dim sendNewEmail As Boolean = False

 

        'the body of the thank you email for a new recipient

        Dim emailBodyToSendAfterNewRegistrationUrl As String = Nothing

 

        'the text to display on the browser for a new recipient

        Dim browserTextAfterNewRegistrationUrl As String = Nothing

 

        'the body of the thank you email for an exisiting recipient

        Dim emailBodyToSendAfterExistRegistrationUrl As String = Nothing

 

        'the text to display on the browser for an existing recipient

        Dim browserTextAfterExistRegistrationUrl As String = Nothing

 

        'the email charset

        Dim charset As String = "utf-8"

 

        'the thank you email subject for an existing recipient

        Dim subjectForExising As String = Nothing

 

        'the thank you email subject for a new recipient

        Dim subjectForNew As String = Nothing

 

        'if the email already exists, update the details?

        Dim update As Boolean = True

 

        'send email for an existing recipient

        Dim sendExistingEmail As Boolean = False

 

        'the custom fields values

        Dim fields() As InwiseWebServices.CustomFieldValue = Nothing

 

        Dim browserTextOrRedirectUrl = ws.Recipients_SignUpRecipient(email, doubleoptin, fields, groups, sendNewEmail, emailBodyToSendAfterNewRegistrationUrl, browserTextAfterNewRegistrationUrl, emailBodyToSendAfterExistRegistrationUrl, browserTextAfterExistRegistrationUrl, charset, subjectForExising, subjectForNew, update, sendExistingEmail)




Home  |  About us  |  Products  |  Service  |  Partners  |  Forum  |  Email Marketing Terms  |  Support  |  Contact us
Terms & Conditions  |  Privacy Policy  |  Anti Spam Policy  |  Site Map
© 2008 inwise LTD. All rights reserved.