POST api/NewsLetter
Request Information
URI Parameters
None.
Body Parameters
NewsLetterSubscriptionInputs| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| JobTitle | string |
None. |
|
| EmailAddress | string |
None. |
|
| PhoneNumber | string |
None. |
|
| Language | string |
None. |
|
| NewsLetterNumber | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"CompanyId": "ed08235b-814c-4319-b19b-b7266e453be3",
"Name": "sample string 2",
"JobTitle": "sample string 3",
"EmailAddress": "sample string 4",
"PhoneNumber": "sample string 5",
"Language": "sample string 6",
"NewsLetterNumber": 7
}
application/xml, text/xml
Sample:
<NewsLetterSubscriptionInputs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Weblysoft.Clients.Models.NewsLetter"> <CompanyId>ed08235b-814c-4319-b19b-b7266e453be3</CompanyId> <EmailAddress>sample string 4</EmailAddress> <JobTitle>sample string 3</JobTitle> <Language>sample string 6</Language> <Name>sample string 2</Name> <NewsLetterNumber>7</NewsLetterNumber> <PhoneNumber>sample string 5</PhoneNumber> </NewsLetterSubscriptionInputs>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NewsLetterSubscriptionResults| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | string |
None. |
|
| Subscriber | Subscriber |
None. |
Response Formats
application/json, text/json
Sample:
{
"Message": "sample string 1",
"Subscriber": {
"SubscriberId": "384cecb6-8c91-4aaa-b4e8-1b9f63de2885",
"CompanyId": "29069fc9-fa01-45db-b605-a87d9c7b3d51",
"Name": "sample string 3",
"EmailAddress": "sample string 4",
"JobTitle": "sample string 5",
"PhoneNumber": "sample string 6",
"Biography": "sample string 7",
"PictureUrl": "sample string 8",
"Subscribed": true,
"DeletedDate": "2025-11-04T16:57:32.366277-08:00",
"CreatedDate": "2025-11-04T16:57:32.3672758-08:00",
"ModifiedDate": "2025-11-04T16:57:32.3672758-08:00"
}
}
application/xml, text/xml
Sample:
<NewsLetterSubscriptionResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Weblysoft.Clients.Models.NewsLetter">
<Message>sample string 1</Message>
<Subscriber>
<Biography>sample string 7</Biography>
<CompanyId>29069fc9-fa01-45db-b605-a87d9c7b3d51</CompanyId>
<CreatedDate>2025-11-04T16:57:32.3672758-08:00</CreatedDate>
<DeletedDate>2025-11-04T16:57:32.366277-08:00</DeletedDate>
<EmailAddress>sample string 4</EmailAddress>
<JobTitle>sample string 5</JobTitle>
<ModifiedDate>2025-11-04T16:57:32.3672758-08:00</ModifiedDate>
<Name>sample string 3</Name>
<PhoneNumber>sample string 6</PhoneNumber>
<PictureUrl>sample string 8</PictureUrl>
<Subscribed>true</Subscribed>
<SubscriberId>384cecb6-8c91-4aaa-b4e8-1b9f63de2885</SubscriberId>
</Subscriber>
</NewsLetterSubscriptionResults>