This document facilitates the management of Informz subscribers. It is designed for infrequent subscriber data updates. If you expect to be regularly updating subscriber data, Informz recommends the BulkUpload method.
This document is processed synchronously.
The InterestAction has two options:
- AddOrUpdateSubscribers
- ReplaceAllSubscribers
In the Subscribe and Unsubscribe actions, the Email and ID fields must be depicted as the example below shows.
- Email is the first entry
- ID is the second entry
- The <ID> tag must be uppercase
<Subscriber> <Email>test2@example.com</Email> <ID>2</ID> </Subscriber>
Request
<ActionRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Test Brand</Brand> <User></User> <Actions> <Subscribe> <InterestDetails> <InterestNames> <InterestName>Sample Interest 1</InterestName> <InterestName>Sample Interest 2</InterestName> </InterestNames> <InterestAction>ReplaceAllSubscribers</InterestAction> </InterestDetails> <SubscriberData> <FieldDefinitions> <FieldDefinition> <Name>First_Name</Name> <DataType>String</DataType> <DefaultValue>Customer</DefaultValue> </FieldDefinition> <FieldDefinition> <Name>Last_Name</Name> <DataType>String</DataType> <DefaultValue>McCustomer</DefaultValue> </FieldDefinition> </FieldDefinitions> <Subscribers> <Subscriber> <Email>steve@example.com</Email> <ID>321</ID> <Fields> <Field element="First_Name">Steve</Field> <Field element="Last_Name">Sanders</Field> </Fields> </Subscriber> <Subscriber> <Email>mary@example.com</Email> <ID>6612</ID> <Fields> <Field element="First_Name">Mary</Field> <Field element="Last_Name">Lamb</Field> </Fields> </Subscriber> <Subscriber> <Email>chuck@example.com</Email> <ID>5143</ID> <Fields> <Field element="First_Name">Chuck</Field> <Field element="Last_Name">Norris</Field> </Fields> </Subscriber> </Subscribers> </SubscriberData> </Subscribe> </Actions> </ActionRequest>
Details
Node | Type | Description |
---|---|---|
<Email> | String(100) | Email address |
<ID> | Int | The unique remote ID in the partner application. |
Notes
- Email address does not have to be unique within Informz.
- Both elements are required.
- Incoming email addresses are converted to lowercase.
- Subscribers that cannot be created are presented within the <InvalidSubscribers> tag
Response (with no invalid email addresses)
<?xml version="1.0" encoding="utf-16"?> <ActionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id=“0”>Brand1</Brand> <User></User> <Responses> <Subscribe> <Count>0</Count> <ActionStatus> <Status>success</Status> <Message xsi:type="xsd:string">3 total records: 3 added. 0 previous subscribers. 0 previous unsubscribers. 0 duplicate subscribers. 0 invalid addresses.</Message> </ActionStatus> <InvalidSubscribers /> </Subscribe> </Responses> </ActionResponse>