Arlo

REST Auth API: ContactMarketing

ContactMarketing resources are a subresource of Contact, and contain various marketing related properties.

ContactMarketing instance resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/contacts/{ContactID}/marketing/

General structure

<ContactMarketingInfo>
  <NewsletterSubscriber>true</NewsletterSubscriber>
  <SuppressBulkEmail>false</SuppressBulkEmail>
  <SuppressBulkPost>false</SuppressBulkPost>
  <NewsletterSubscribedTopics>
    <Topic>Marketing</Topic>
    <Topic>Sales</Topic>
    <Topic>Company updates</Topic>
    <Topic>Quote of the day</Topic>
  </NewsletterSubscribedTopics>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/29/marketing/" />
</ContactMarketingInfo>

Resource properties

Property Description
NewsletterSubscriber A Boolean value noting whether the associated contact resource is a newsletter subscriber.
SuppressBulkEmail A Boolean value indicating whether the contact has opted out of bulk email marketing.
SuppressBulkPost A Boolean value indicating whether the contact has opted out of bulk post marketing.
NewsletterSubscribedTopics A list of subcribed Topic strings for the contact.

HTTP GET

Returns a representation of a ContactMarketing, including the properties and links above.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
Example

GET /demo/api/2012-02-01/auth/resources/contacts/562/marketing/

<ContactMarketingInfo>
  <NewsletterSubscriber>true</NewsletterSubscriber>
  <SuppressBulkEmail>false</SuppressBulkEmail>
  <SuppressBulkPost>false</SuppressBulkPost>
  <NewsletterSubscribedTopics>
    <Topic>Marketing</Topic>
    <Topic>Sales</Topic>
    <Topic>Company updates</Topic>
    <Topic>Quote of the day</Topic>
  </NewsletterSubscribedTopics>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/29/marketing/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Contact" type="application/xml" title="Contact" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/29/" />
</ContactMarketingInfo>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.