Loading...
Area: Episerver Campaign
Applies to versions: Not applicable

sendtransactionmail

This operation creates a new recipient and sends an event mailing to this recipient in Episerver Campaign.

Additional parameters for personalization can be transmitted. You can also send fax, SMS, or printed messages (see Sending print messages) if your client is configured accordingly. In certain cases, this operation can be used to send event mailings several times to already existing recipients.

Notes on using this operation
* You can use this operation to send mailings to existing recipients.
* Each call of this operation creates a new recipient dataset.
* Unsubscribes and bounces are always associated with the ID field (which may be, for example, the email address) of the recipient list used.
* Use this operation only for confirmation mails, notifications, status mails, or new subscriptions in case recipients forgot their password.
* Some of these transactional mails must not contain promotional content.
* This operation is available in the form service.
* You need a transaction recipient list (recipient list with the property "Transaction API") and its authorization code. See API overview. To set up a transaction recipient list, contact customer support.

Warning: Never use this HTTP API request directly on a web page. HTTP API requests of the form service must always be executed by the server without exposing the used source code to others. Otherwise there is a potential risk that other web user read these data and send emails from your client and at your expense.

Parameters

Name Mandatory Default value Description

bmRecipientId

yes

If the mailing is of the type email, the parameter must contain the email address of the recipient. If an SMS or fax is sent, the parameter must contain the telephone number of the recipient.

bmMailingId

yes

The ID of the mailing (type: event) to be sent. The mailing must be associated with the same recipient list used by the authorization code.

bmPersonalizedAttachmentsToken

no

To send an attachment, set the value of this parameter to the return value of the operation uploadpersonalizedattachments (i.e., the token). The personalized attachment feature must first be activated by customer support.

bmSanitize

no

Set the value of this parameter to true to convert potentially dangerous characters in the supplied recipient data into their respective HTML equivalents .

...

no

Any parameter that corresponds to a parameter of the recipient list.

Return values

Value Description
enqueued: <bmMailId>

The sending process has been started. Invoke the operation getsendstatus to get sending status details.

not_found

The transmitted mailing with the given bmMailingId could not be found.

wrong_tag

Authorization failed.

Error codes:

  • 501=wrong authentication tag
  • 502=wrong request IP
  • 503=wrong request method
  • 504=wrong protocol
  • 505=wrong recipient list
  • 506=wrong action
  • 507=action not found

Note: If a verification of the authentication tag does not solve the problem, contact customer support.

missing_id

No bmMailingId and/or no bmRecipientId was/were transmitted.

syntax_error

The transmitted bmRecipientId or another parameter is invalid.

syntax_error: Invalid bmPersonalizedAttachmentsToken.

The token is expired, was not created for this client, or has been tampered with.

wrong_mailing_type

The mailing is not of the type event.

wrong_mailing_type: Personalized attachments can only be used with EMAIL-mailings.

Personalized attachments can only be used for mailings of the media type email.

wrong_mailing_status

The mailing with the given bmMailingId was stopped, is finished or the property of the used recipient list is not Transaction API.

system_error

A general error occurred.

Example 1

.../form/.../sendtransactionmail?bmRecipientId=john.smith%40example.com&bmMailingId=12345 

The mailing with the ID "12345" is sent to the recipient with the ID "john.smith@example.com".

Example 2

.../form/.../sendtransactionmail?bmRecipientId=john.smith%40example.com&
bmMailingId=12345&bmPersonalizedAttachmentsToken=1a2b3c456 

The mailing with the ID "12345" is sent to the recipient with the ID "john.smith@example.com" along with a personalized attachment (using the token "1a2b3c456"). For more examples for using the personalized attachments, refer to Personalized attachments — Examples.

Sending print messages

To also send print messages with this operation, use the operation as described, do not enter a bmRecipientId, and apply the following additional print recipient list fields:

Recipient list field name Mandatory Notes

bmletteraddress_salutation

No

Contains the salutation

bmletteraddress_firstname

No

Contains the first name

bmletteraddress_lastname

Yes

Contains the last name

If you wish to use only company name for business addresses (without providing the name of a staff member), enter that here.

bmletteraddress_extraaddressline

No

Contains the extra address line

Note: If this is a business address and you have entered the name of a staff member in the last name field, then enter the company name into this field. The letter cannot be delivered without this.

bmletteraddress_street

Yes

Contains the street name

Mandatory field along with Number.

Note: The Street and Number and PO box fields must be left empty.

bmletteraddress_streetnumber

Yes

Contains the building number

Mandatory field along with Street.

Note: The Street and Number and PO box fields must be left empty.

bmletteraddress_streetandnumber

No

 Contains the street and building number

Note: When using this field, the Street, Number and PO box fields must be left empty.

bmletteraddress_postofficebox

No

Contains the PO Box

Note: When using this field, the Street, Number and Street and Number fields must be left empty.

bmletteraddress_zipcode

Yes

Contains the postcode

bmletteraddress_city

Yes

Contains the town/city

bmletteraddress_countrycode

Yes

Contains the country code

This field must be set to DE. Dispatch is only available within Germany.

Last updated: Apr 17, 2019