POST Marketing/AddNewsletterSubscriber

Request Information

URI Parameters

None.

Body Parameters

AddNewsletterSubscriberBinding
NameDescriptionTypeAdditional information
NewsletterID

integer

None.

CustomerID

Optionally use to bind this subscriber to a customer

string

String length: inclusive between 0 and 128

Email

Equals Customer.Contact.Email, if CustomerID != null

string

Required

String length: inclusive between 0 and 200

Name

string

Required

String length: inclusive between 0 and 100

Surnames

string

String length: inclusive between 0 and 100

Gender

Gender

None.

DateOfBirth

date

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "NewsletterID": 1,
  "CustomerID": "sample string 2",
  "Email": "sample string 3",
  "Name": "sample string 4",
  "Surnames": "sample string 5",
  "Gender": 1,
  "DateOfBirth": "2024-11-13T15:51:53.7429616+01:00",
  "Lang": "sample string 6",
  "StoreID": 7
}

application/xml, text/xml

Sample:
<AddNewsletterSubscriberBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Binding">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 6</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">7</StoreID>
  <CustomerID>sample string 2</CustomerID>
  <DateOfBirth>2024-11-13T15:51:53.7429616+01:00</DateOfBirth>
  <Email>sample string 3</Email>
  <Gender>Male</Gender>
  <Name>sample string 4</Name>
  <Surnames>sample string 5</Surnames>
  <NewsletterID>1</NewsletterID>
</AddNewsletterSubscriberBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>