POST example/api/publication/optin/mailrecipients

https://app.bwz.se/bedrock/example/api/publication/optin/mailrecipients

Adds MailRecipients to a Publication opt-in list.

Request Information

URI Parameters

None.

Body Parameters

IDs of the MailRecipients that will be added to the Publication opt-in list.

Name	Description	Type	Additional information
PublicationId	ID of the Publication the MailRecipients will opt-in to.	integer	None.
MailRecipientIds	IDs of the MailRecipients that will be added to the Publication opt-in list.	Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "PublicationId": 1,
  "MailRecipientIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<CreateMailPublicationOptInArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailPublicationOptIn">
  <MailRecipientIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </MailRecipientIds>
  <PublicationId>1</PublicationId>
</CreateMailPublicationOptInArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of MailPublicationOptInModels that has been created.

Collection of MailPublicationOptInModel

Name	Description	Type	Additional information
MailRecipientId	Gets or sets the ID of the opt-in MailRecipient.	integer	None.
OptInDate	Gets or sets the opt-in date and time.	date	None.
PublicationId	Gets or sets the ID of the opt-in Publication.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MailRecipientId": 1,
    "OptInDate": "2024-11-21T17:57:42.6701652+01:00",
    "PublicationId": 3
  },
  {
    "MailRecipientId": 1,
    "OptInDate": "2024-11-21T17:57:42.6701652+01:00",
    "PublicationId": 3
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailPublicationOptInModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailPublicationOptIn">
  <MailPublicationOptInModel>
    <MailRecipientId>1</MailRecipientId>
    <OptInDate>2024-11-21T17:57:42.6701652+01:00</OptInDate>
    <PublicationId>3</PublicationId>
  </MailPublicationOptInModel>
  <MailPublicationOptInModel>
    <MailRecipientId>1</MailRecipientId>
    <OptInDate>2024-11-21T17:57:42.6701652+01:00</OptInDate>
    <PublicationId>3</PublicationId>
  </MailPublicationOptInModel>
</ArrayOfMailPublicationOptInModel>