Recent pages

Edit
page

New
page

Print
page
Page last modified 17:25, 6 Jan 2012 by Admin
0
Redirect
Page Notifications Off
Documentation Wiki > Developer Documentation > XML API > Batch API Guide > Retrieve Subscriber Statuses (Bulk Async)

Retrieve Subscriber Statuses (Bulk Async)

From $1

    Doc-Wiki-BannerHK.png

    (Click the banner to go to the related Docs.Code.ExactTarget.com page.)

    The Retrieve Subscriber Statuses (Bulk Async) call retrieves the status for every subscriber in your account. Enterprise accounts receive information from all subscribers in all applicable accounts. The ExactTarget application includes this information in a compressed .ZIP file and places that file on your FTP site or another secure FTP site.

    You can include a listID to retrieve status for a specific list only. The call immediately returns a batchID and places the results on the specified FTP site.

    This call returns only one instance of each subscriber, even if multiple Enterprise accounts use the same subscriber:

    • If the subscriber has an Unsubscribed status for any account, the call returns a status of Unsubscribed.
    • If the subscriber is listed as Undeliverable for any account, the call returns a status of Undelieverable.
    • If the subscriber is listed as Returned for any account, the call returns a status of Returned.
    • If none of the above cases apply to the subscriber, the call returns a status of Active.

    Method

    This call can be used in Enterprise accounts using the modification noted below.

    Standard (Non-Enterprise)

    To retrieve all subscriber statuses on the All Subscribers list, use the following syntax:

    <system>
    <system_name>subscriber</system_name>    
    <action>BulkAsync</action>
    <sub_action>SubsStatus_ToFTP</sub_action>
    <search_type></search_type>
    <search_value></search_value>
    <search_value2></search_value2>
</system>

    To retrieve statuses for a specified subscriber list, specify the list ID, as follows:

    <system>
    <system_name>subscriber</system_name>
    <action>BulkAsync</action>
    <sub_action>SubsStatus_ToFTP</sub_action>
    <search_type>lid</search_type>
    <search_value>1234</search_value>
    <search_value2></search_value2>
</system>

    Enterprise Accounts

    If you are retrieving subscriber statuses for an Enterprise account and its children accounts, use the following value for the <action> tag:

    <action>BulkAsyncEnterprise</action>

    All other syntax is the same as for standard accounts.

    See also the information about Enterprise usage of this call in the Additional Info section at the top of this help topic.

    Results Sent to Your Own FTP Site

    With this call, you have the option of picking up the resulting file from your own FTP site rather than from the ExactTarget secure FTP site, by including the <results> node in your call. See the Output for a Batch File Export (Bulk Async) Call help topic for the syntax to use.

    Parameters

    XML Tag

    Tag Description

    <search_value>

    (Used only with the option of specifying a list ID.)

    The list ID of the ExactTarget list whose subscriber statuses you want to retrieve.

    If you're not specifying a list ID, leave this tag blank.

    <search_value2>

    Leave the value for this tag blank. (Do not omit the tag.)

    Results

    The immediate results of this call will be a confirmation message and the batch ID for this request, as described in Output for a Batch File Export (Bulk Async) Call. Use the batch ID to check on the status of the request; see Batch Inquire (Status Check).

    The zipped file that will be deposited to the secure FTP site (or to your own FTP site, if you used the <results> node in your call) will contain the subscriber statuses, as shown in this example. If the subscriber status is Unsubscribed, the results will also include the unsubscribe reason.

    <?xml version="1.0"?>
    <exacttarget>
        <system>
            <subs>
                <sub>
                    <email>bob@example.com</email>
                    <status>Active</status>
                    <reason/>
                </sub>
                <sub>
                    <email>mary@example.com</email>
                    <status>Unsubscribed</status>
                    <reason>Unsubscribed from the Subscription Center</reason>
                </sub>
            </subs>
        </system>
    </exacttarget>

    This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:25:55 GMT.

    If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:

     

    Was This Page Helpful?
    Suggestions or Comments:
    Name (optional):
    Email Address (optional):
    Enter 13630 backwards:
       
    Tags: (Edit tags)
    • No tags
    Attach file or image
    Files (0)
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch 2010
    Admin