POST example/api/publication/smsoptouts
https://app.bwz.se/bedrock/example/api/publication/smsoptouts
Creates a publication optout.
Request Information
URI Parameters
None.
Body Parameters
Sets the mobile number that will be optouted.
CreateSmsPublicationOptOutArgsName | Description | Type | Additional information |
---|---|---|---|
PublicationId |
Sets the ID of the Publication |
integer |
None. |
MobileNumber |
Sets the mobile number that will be optouted. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "PublicationId": 1, "MobileNumber": "sample string 2" }
application/xml, text/xml
Sample:
<CreateSmsPublicationOptOutArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsPublicationOptOut"> <MobileNumber>sample string 2</MobileNumber> <PublicationId>1</PublicationId> </CreateSmsPublicationOptOutArgs>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The SmsPublicationOptOutModel that has been created.
SmsPublicationOptOutModelName | Description | Type | Additional information |
---|---|---|---|
MobileNumber |
Gets or sets the mobile number address of the SmsPublicationOptOut. |
string |
None. |
Id |
Gets or sets the id of the SmsPublicationOptOut. |
integer |
None. |
OptOutDate |
Gets or sets the opt out date of the SmsPublicationOptOut. |
date |
None. |
PublicationId |
Gets or sets the publication id of the SmsPublicationOptOut. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "MobileNumber": "sample string 1", "Id": 2, "OptOutDate": "2024-11-21T17:27:31.0989212+01:00", "PublicationId": 4 }
application/xml, text/xml
Sample:
<SmsPublicationOptOutModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsPublicationOptOut"> <Id>2</Id> <MobileNumber>sample string 1</MobileNumber> <OptOutDate>2024-11-21T17:27:31.0989212+01:00</OptOutDate> <PublicationId>4</PublicationId> </SmsPublicationOptOutModel>