POST api/NewsLetter
Request Information
URI Parameters
None.
Body Parameters
NewsLetterSubscriptionInputsName | 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": "6fe42c93-6e38-4c3a-9e58-028662194e52", "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>6fe42c93-6e38-4c3a-9e58-028662194e52</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
NewsLetterSubscriptionResultsName | Description | Type | Additional information |
---|---|---|---|
Message | string |
None. |
|
Subscriber | Subscriber |
None. |
Response Formats
application/json, text/json
Sample:
{ "Message": "sample string 1", "Subscriber": { "SubscriberId": "caaa1d2a-cce7-4749-9e5a-d37cf73a3883", "CompanyId": "431a904c-8d8d-4b87-b8ea-54db81d58a93", "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-04-03T20:39:04.3451587-07:00", "CreatedDate": "2025-04-03T20:39:04.3451587-07:00", "ModifiedDate": "2025-04-03T20:39:04.3451587-07: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>431a904c-8d8d-4b87-b8ea-54db81d58a93</CompanyId> <CreatedDate>2025-04-03T20:39:04.3451587-07:00</CreatedDate> <DeletedDate>2025-04-03T20:39:04.3451587-07:00</DeletedDate> <EmailAddress>sample string 4</EmailAddress> <JobTitle>sample string 5</JobTitle> <ModifiedDate>2025-04-03T20:39:04.3451587-07:00</ModifiedDate> <Name>sample string 3</Name> <PhoneNumber>sample string 6</PhoneNumber> <PictureUrl>sample string 8</PictureUrl> <Subscribed>true</Subscribed> <SubscriberId>caaa1d2a-cce7-4749-9e5a-d37cf73a3883</SubscriberId> </Subscriber> </NewsLetterSubscriptionResults>