POST api/RegisterYourInterest

Add somebody to a specific list within Engage Newsletter

Request Information

URI Parameters

None.

Body Parameters

RegisterYourInterestDTO
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 registering their interest

string

Required

Max length: 255

MobilePhone

The mobile phone number of the person registering their interest

string

Max length: 20

SiteId

The site id the visitor is registering their interest for

string

Required

Max length: 3

Min length: 3

EngageNewsletterSubscriberListId

The Subscriber List Id from Engage Newsletter to subscribe this visitor to

string

Required

Max length: 255

Request Formats

application/json, text/json

Sample:
{
  "EmailAddress": "email@surgefitness.com.au",
  "Name": "John Smith",
  "MobilePhone": null,
  "SiteId": null,
  "EngageNewsletterSubscriberListId": "1234567890"
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:
EmailAddress=value&Name=value&MobilePhone=value&SiteId=value&EngageNewsletterSubscriberListId=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.