POST example/api/mailmessage/{mailMessageId}/addlimerecipients

https://app.bwz.se/bedrock/example/api/mailmessage/{mailMessageId}/addlimerecipients

Gets recipients from a Lime CRM mailing and inserts them to a MailRecipientList. Since parallel imports are not supported it is possible to get a ServiceUnavaliable response with a RetryAfter header. Try to post your request again after the timeout.

Request Information

URI Parameters

Name	Description	Type	Additional information
mailMessageId		integer	Required

Body Parameters

Should Total Opt Out be overrridden

AddLimeRecipientsArgs

Name	Description	Type	Additional information
LimeCRMMailingId	The record Id of the maailing in Lime CRM	integer	Required
TransactionHandlerId	The Id of the TransactionHandler	integer	Required
ListName	The name of the import	string	Required
OverridePublicationOptOut	Should Publication Opt Out be overridden	boolean	None.
OverrideTotalOptOut	Should Total Opt Out be overrridden	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "LimeCRMMailingId": 1,
  "TransactionHandlerId": 2,
  "ListName": "sample string 3",
  "OverridePublicationOptOut": true,
  "OverrideTotalOptOut": true
}

application/xml, text/xml

Sample:

<AddLimeRecipientsArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailMessage">
  <LimeCRMMailingId>1</LimeCRMMailingId>
  <ListName>sample string 3</ListName>
  <OverridePublicationOptOut>true</OverridePublicationOptOut>
  <OverrideTotalOptOut>true</OverrideTotalOptOut>
  <TransactionHandlerId>2</TransactionHandlerId>
</AddLimeRecipientsArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ImportResultModel

Name	Description	Type	Additional information
ExistingRecipients	Nubmer of MailRecipients that already existed.	integer	None.
NewRecipientsCreated	Number of new MailRecipients created.	integer	None.
RecipientsAddedToList	Number of MailRecipients that was added to list.	integer	None.
RecipientsNotImported	Number of MailRecipients that wasn't imported.	integer	None.
SharedBlockedRecipients	Number of MailRecipients that wasn't imported due to shared block list.	integer	None.
ImportStatus	Status of the import.	BackgroundImportStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "ExistingRecipients": 1,
  "NewRecipientsCreated": 2,
  "RecipientsAddedToList": 3,
  "RecipientsNotImported": 4,
  "SharedBlockedRecipients": 5,
  "ImportStatus": 0
}

application/xml, text/xml

Sample:

<ImportResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models">
  <ExistingRecipients>1</ExistingRecipients>
  <ImportStatus>INIT</ImportStatus>
  <NewRecipientsCreated>2</NewRecipientsCreated>
  <RecipientsAddedToList>3</RecipientsAddedToList>
  <RecipientsNotImported>4</RecipientsNotImported>
  <SharedBlockedRecipients>5</SharedBlockedRecipients>
</ImportResultModel>