POST Newsletters

Subscribe to newsletter. User Authorization Optional.

Request Information

URI Parameters

None.

Body Parameters

Newsletter information.

Newsletter
NameDescriptionTypeAdditional information
EmailAddress

Email address to send the newsletter. (Optional if sending authenticated user info in auth header)

 string

None.
Newsletters

Optional: List of comma separated newsletter ids. (defaults to bible trivia newsletter)

 string

None.
SignupUrl

Optional (Default /)

 string

None.
SignupLocation

Optional: location of signup like takeover, etc. (defaults to login)

 string

None.
SignupDomain

Optional (Default www.christianity.com)

 string

None.
SignupPage

Optional: 1=HomePage, 2=SecondaryPage, 3=NameAcquisition, 4=Facebook, 5=WebService, 6=Other, 7=Offsite (Default 5)

 NewsletterSignupPage

None.
ThirdPartySource

Optional

 string

None.
ThirdPartyDomain

Optional

 string

None.
SignupIp

Optional: ip address (default from response info)

 string

None.
FirstName

Optional

 string

None.
LastName

Optional

 string

None.
Address1

Optional

 string

None.
Address2

Optional

 string

None.
City

Optional

 string

None.
State

Optional

 string

None.
PostalCode

Optional

 string

None.
Country

Optional

 string

None.
Gender

Optional

 string

None.
BirthDate

Optional

 string

None.
PhoneNumber

Optional

 string

None.
WorkPhoneNumber

Optional

 string

None.
CompanyName

Optional

 string

None.
AreaCode

Optional

 string

None.
CongressionalDistrict

Optional

 string

None.
DmaId

Optional

 string

None.
DmaName

Optional

 string

None.
CountryCode

Optional

 string

None.
TimeZone

Optional

 string

None.
ReferrerInfo

Optional

 string

None.
ApiUrl

Link

None.
ResourceObjectType

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "emailAddress": "sample string 1",
  "newsletters": "sample string 2",
  "signupUrl": "sample string 3",
  "signupLocation": "sample string 4",
  "signupDomain": "sample string 5",
  "signupPage": 1,
  "thirdPartySource": "sample string 6",
  "thirdPartyDomain": "sample string 7",
  "signupIp": "sample string 8",
  "firstName": "sample string 9",
  "lastName": "sample string 10",
  "address1": "sample string 11",
  "address2": "sample string 12",
  "city": "sample string 13",
  "state": "sample string 14",
  "postalCode": "sample string 15",
  "country": "sample string 16",
  "gender": "sample string 17",
  "birthDate": "sample string 18",
  "phoneNumber": "sample string 19",
  "workPhoneNumber": "sample string 20",
  "companyName": "sample string 21",
  "areaCode": "sample string 22",
  "congressionalDistrict": "sample string 23",
  "dmaId": "sample string 24",
  "dmaName": "sample string 25",
  "countryCode": "sample string 26",
  "timeZone": "sample string 27",
  "referrerInfo": "sample string 28",
  "resourceObjectType": "newsletter"
}

application/xml, text/xml

Sample: 
<Newsletter xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ApiUrl i:nil="true" />
  <ResourceObjectType>newsletter</ResourceObjectType>
  <Address1>sample string 11</Address1>
  <Address2>sample string 12</Address2>
  <AreaCode>sample string 22</AreaCode>
  <BirthDate>sample string 18</BirthDate>
  <City>sample string 13</City>
  <CompanyName>sample string 21</CompanyName>
  <CongressionalDistrict>sample string 23</CongressionalDistrict>
  <Country>sample string 16</Country>
  <CountryCode>sample string 26</CountryCode>
  <DmaId>sample string 24</DmaId>
  <DmaName>sample string 25</DmaName>
  <EmailAddress>sample string 1</EmailAddress>
  <FirstName>sample string 9</FirstName>
  <Gender>sample string 17</Gender>
  <LastName>sample string 10</LastName>
  <Newsletters>sample string 2</Newsletters>
  <PhoneNumber>sample string 19</PhoneNumber>
  <PostalCode>sample string 15</PostalCode>
  <ReferrerInfo>sample string 28</ReferrerInfo>
  <SignupDomain>sample string 5</SignupDomain>
  <SignupIp>sample string 8</SignupIp>
  <SignupLocation>sample string 4</SignupLocation>
  <SignupPage>HomePage</SignupPage>
  <SignupUrl>sample string 3</SignupUrl>
  <State>sample string 14</State>
  <ThirdPartyDomain>sample string 7</ThirdPartyDomain>
  <ThirdPartySource>sample string 6</ThirdPartySource>
  <TimeZone>sample string 27</TimeZone>
  <WorkPhoneNumber>sample string 20</WorkPhoneNumber>
</Newsletter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Newsletter'.

Response Information

Resource Description

Response indicating if success or not.

ApiResponse
NameDescriptionTypeAdditional information
ResultType

ResultType

None.
Messages

Collection of string

None.
Links

Links

None.
ApiBaseUrl

string

None.
responseObjectType

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "resultType": {
    "code": 0,
    "message": "Success"
  },
  "messages": [
    "sample string 1",
    "sample string 2"
  ],
  "links": {},
  "apiBaseUrl": "sample string 1",
  "responseObjectType": "apiResponse"
}

application/xml, text/xml

Sample: 
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ApiBaseUrl>sample string 1</ApiBaseUrl>
  <Links>
    <First i:nil="true" />
    <Last i:nil="true" />
    <Next i:nil="true" />
    <Previous i:nil="true" />
    <Self i:nil="true" />
  </Links>
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <ResultType>
    <Code>Success</Code>
    <Message>Success</Message>
  </ResultType>
  <responseObjectType>apiResponse</responseObjectType>
</ApiResponse>