HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In


Creates a new recipient and sends an event mailing to this recipient in Optimizely Campaign.

Additional parameters for personalization can be transmitted. You can also send 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 be free of 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.



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.


NameMandatoryDefault valueDescription
bmRecipientIdyesIf the mailing is of the type email, the parameter must contain the email address of the recipient. If an SMS is sent, the parameter must contain the telephone number of the recipient.
bmMailingIdyesThe ID of the mailing (type: event) to be sent. The mailing must be associated with the same recipient list used by the authorization code.
bmPersonalizedAttachmentsTokennoTo 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.
bmSanitizenoSet the value of this parameter to true to convert potentially dangerous characters in the supplied recipient data into their respective HTML equivalents .
...noAny parameter that corresponds to a parameter of the recipient list.

Return values

enqueued: <bmMailId>The sending process has been started. Invoke the operation getsendstatus to get sending status details.
not_foundThe transmitted mailing with the given bmMailingId could not be found.
wrong_tagAuthorization 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

  • If a verification of the authentication tag does not solve the problem, contact [customer support](mailto:[email protected]). | | 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


    The mailing with the ID 12345 is sent to the recipient with the ID [email protected].

    Example 2


    The mailing with the ID 12345 is sent to the recipient with the ID [email protected] along with a personalized attachment (using the token 1a2b3c456). For more examples for using the personalized attachments, see 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 nameMandatoryNotes
    bmletteraddress_salutationNoContains the salutation
    bmletteraddress_firstnameNoContains the first name
    bmletteraddress_lastnameYesContains 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_extraaddresslineNoContains 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_streetYesContains the street name

    Mandatory field along with Number.

    Note: The Street and Number and PO box fields must be left empty.
    bmletteraddress_streetnumberYesContains the building number

    Mandatory field along with Street.

    Note: The Street and Number and PO box fields must be left empty.
    bmletteraddress_streetandnumberNoContains the street and building number

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

    Note: When using this field, the Street, Number and Street and Number fields must be left empty.
    bmletteraddress_zipcodeYesContains the postcode
    bmletteraddress_cityYesContains the town/city
    bmletteraddress_countrycodeYesContains the country code

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

    What’s Next