POST api/SubscribeToNewsletter

Add somebody to the Surge Newsletter list within Engage Newsletter

Request Information

URI Parameters

None.

Body Parameters

NewsletterSubscriberDTO
NameDescriptionTypeAdditional information
EmailAddress

The email address you wish to subscribe. Note: this will be validated to ensure it's a syntactically valid email address and will return a BadRequest if invalid

string

Required

Name

The name of the person subscribing to the newsletter

string

Required

Max length: 255

SiteId

The site id the visitor wishes to recieve the newsletter for

string

Required

Max length: 3

Min length: 3

Request Formats

application/json, text/json

Sample:
{
  "EmailAddress": "email@surgefitness.com.au",
  "Name": "John Smith",
  "SiteId": "CLA"
}

application/xml, text/xml

Sample:
<NewsletterSubscriberDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SurgeAPI.Models">
  <EmailAddress>email@surgefitness.com.au</EmailAddress>
  <Name>John Smith</Name>
  <SiteId>CLA</SiteId>
</NewsletterSubscriberDTO>

application/x-www-form-urlencoded

Sample:
EmailAddress=value&Name=value&SiteId=value

Response Information

Resource Description

200-OK if the registration was a success 400-BadRequest if there was an issue completing the registration (body contains reason)

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.