Overview and Request Content

Prev Next

Overview

This API is used to cancel an active EasySend digital transaction. The transaction could have been created by an integration, the Journey Sender or by organically opening a digital journey link in a browser.

URL Path 

player/api/cancel-request

Method

 A POST request should be performed with the following HTTP Header: Content-Type: application/json.

Authentication Using apiKey Field

The apiKey allows EasySend to use a simple authentication mechanism that is used to authenticate the client against the server. The apiKey must be passed with every API call.

Warning!
Your apiKey is private and should always be kept secret. Never share your API key with a 3rd party. Always trigger EasySend APIs from a server-side application. Avoid embedding your API key in a client-side / web-based application.

Request Content

Table 1 describes the required request content parameters.

Table 1: Request Content

ParameterTypeOptional/Required Discerption
apiVersionintegerRequiredThe API version
apiKeystringRequiredThe API key for the provided environment 
ridstring
RequiredAn rid of an active request, as returned from /generate-link

Return Value

The HTTP status code will determine the success/failure of the response. The return code 200 is a success, and any other return code is considered an error.

Using Journeys and the new AI-Builder? Get the configuration docs and resources you need. Go to Help Center

Can’t find what you’re looking for?

Let us know what you need and we'll help you as soon as possible.