Document toolboxDocument toolbox

Blueshift Access Cancellation Email

Summary / TL:DR: This article will introduce you to Auto Cancellation Emails for an Access (AMB) service in Blueshift.

3 min read


Table of contents


Capability

Send an email through Blueshift to confirm when a customer cancels an Access* service.

*Also known as AMB.


Description

When an Access service is cancelled by a customer, the agreement record for that customer is updated in Advantage. The Advantage workflow captures the update and generates an event to inform Blueshift about the action. This event then triggers a campaign in Blueshift.


Blueshift Event Name

access_cancellation


Event Payload Parameters

Parameter

Description

Parameter

Description

event

Name of triggering event

owning_org

Code for the legal entity associated with this access service

email

Email address of billTo customer

customer_firstname

First name of billTo customer

customer_lastname

First name of billTo customer

retailer_customer_id

Concatenation of [Advantage billTo customer number]-[Advantage billTo emailId]

billing_currency

Currency type associated with the transaction

service_period

Defined length of an agreement

service_period_description

Associated description name for the service_period

expiration_date

The date on which access to specific content ends

start_date

The date on which access to specific content begins

renewal_flag

Indicates whether a renewal notice should be sent to the subscriber

order_number

Unique identifier of the cancellation order

transaction_amount

Amount to be refunded due to cancellation

line_item

Total number of items included in an order

item_number

Code used to identify the stock item

item_quantity

Number of individual items included of the associated item number

service_type_description

Associated description name for the way of packaging content within an access service


Sample Payload

 

{ "event":"access_cancellation", "owning_org":"625", "email":"email@14west.us", "customer_firstname":"Jen", "customer_lastname":"Mathew", "retailer_customer_id":"000123869643-000119386557", "billing_currency":"US$", "service_period":"Y-0005", "service_period_description":"1 Year Agreement", "expiration_date":"2025-05-31", "start_date":"2020-06-01", "renewal_flag":"Y", "order_number":"xxxxxxx", "transaction_amount":"216.31", "line_item": [ { "item_number":"OV3SMMH1", "item_quantity":1, "service_type_description":"Micozzi's Heart Attack Protocl" }, { "item_number":"OV3SMMH1C", "item_quantity":1, "service_type_description":"Micozzi's Heart Attack Protocl Con" } ] }

Setting up a Campaign

  1. Create a triggered campaign using the event ‘access_cancellation’.

  2. Set the condition “Skip Global Inclusion Segment Check” to “Yes”.

  3. Select the associated template for your campaign. A sample email called 'FOR_COPY_SAMPLE AMB Cancellation' is available in your Blueshift Production instance.

  4. If one campaign is used for setting up mailing for multiple publications, set the condition “User can be in the campaign journey” to “Multiple times concurrently”. This will allow you to send an email to a customer who cancels multiple subscriptions.

 

 


Reporting

The event name in the payload will be passed in the mailing activity events. This will be available in the reporting platform for filters.


Things to Consider When Planning your Migration and/or Setup

  1. Please follow the Transition Guidelines shared by the MarTech team during your Migration Planning workshop.

  2. If you have an existing Message Central Access Cancellation workflow on Advantage, your new Blueshift workflow has already been set up on Advantage and is ready to send events.

  3. If you never had an Access Cancellation workflow on Advantage, there is no longer a need to share the new campaign ID with the Advantage team during initial set up. The same event category can be used for multiple campaigns, segments, etc. without Advantage configuration support.

  4. The Access Cancellation workflow will account for all owning orgs associated with your Blueshift instance. Please note: additions of new owning orgs must be reported to the MarTech team so it can be added to your Blueshift instance.


Wrap up

You should now have a better understanding of Auto Cancellation Emails for an Access (AMB) service in Blueshift.

Still need help?

We know this can be frustrating. To get further help please open a Support ticket.

Click here to open a ticket


Related Content


Level up with a Masterclass

Evolve course title

Get started!

Evolve course title

Get started!


 

com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'html-macro' is unknown.