Subscriber

This is a Subscriber in our system. Subscribers are the recipients of emails in our system. Please see our Subscriber Overview for a more detailed description.

Fields

Field name Description Type/Allowed values
status The subscriber's status Enumeration of ACTIVE, INACTIVE, OPT_OUT
email The subscriber's email address Email
date_created Timestamp from when subscriber was created Date
source Indicates where the subscriber originated from (e.g. "website", "self-subscriber") Text
mail_format The subscriber's preferred way to receive email Enumeration of TEXT, HTML, blank (i.e. unspecified)
salutation Subscriber's title (e.g. Mr, Ms, etc). Text
first_name Subscriber's first name Text
middle_name Subscriber's middle name Text
surname Subscriber's last name Text
company Subscriber's company Text
position_company Subscriber's job in their company Text
phone_number Subscriber's phone number Phone Number
fax_number Subscriber's fax number [Phone Number
address_1 First line of subscriber's address Text
address_2 Second line of subscriber's address Text
address_3 Third line of subscriber's address Text
city The city the subscriber lives in Text
postal_code The subscriber's post code Text
county_state The state or county the subscriber lives in Text
country The country the subscriber lives in Country
custom_fields A list of custom field values the subscriber has Tag list (custom_field)
custom_field A custom field value the subscriber has Depends on the type of the custom field

Example

<subscriber date_modified="2012-01-17T10:32:11Z" uri="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc">
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc"
        rel="edit"
        title="Edit: Subscriber (1dc0ag2floc)"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/tags"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.tags"
        title="Subscriber (1dc0ag2floc) Tags"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/topics"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.topics"
        title="Subscriber (1dc0ag2floc) Topics"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/sections"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.sections"
        title="Subscriber (1dc0ag2floc) Sections"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/permissions"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.permissions"
        title="Subscriber (1dc0ag2floc) Permissions"/>
    <link
        href="https://api.newsweaver.com/v2/example-account/subscriber/1dc0ag2floc/reviewer_groups"
        rel="http://api-info.newsweaver.com/v2/rels/subscriber.reviewer_groups"
        title="Subscriber (1dc0ag2floc) Reviewer Groups"/>
    <city>New York</city>
    <email>joe.bloggs@example.com</email>
    <status>ACTIVE</status>
    <source>Website</source>
    <surname>Bloggs</surname>
    <company>Acme, Inc.</company>
    <country>United States of America</country>
    <address1>123 Fake Street</address1>
    <address2>Fiction Road</address2>
    <address3>Nowhere</address3>
    <fax_number>555 12345 99</fax_number>
    <first_name>Joe</first_name>
    <salutation>Mr</salutation>
    <middle_name>R</middle_name>
    <mail_format>Html</mail_format>
    <postal_code>1234</postal_code>
    <phone_number>555 12345 88</phone_number>
    <county_state>New York</county_state>
    <date_created>2012-01-17T10:32:11Z</date_created>
    <position_company>Developer</position_company>
</subscriber>

See calls:

results matching ""

    No results matching ""