Activate Message or Voucher

This request is used to activate a message so as it will be sent according to the configured scheduled date.

The same request can be used to activate a configured voucher so as it can be selected during message configuration and to become in effect upon sending such a message.

HTTP Request

URLHTTP MethodDescription<message/configuration_id>/execute GET Activate Message/Voucher

Path Variables

As a prerequisite, before using this request for activating a message or a voucher, the user should have already configured the message or the voucher.

As a result, the relevant configuration id can be passed in the URL as a path variable. In both cases, message or voucher, the configuration id is an alphanumeric string value as shown in the below example.

Sample Request


#Retrieving the XSRF Token needed for Session
pingResponse = my_session.get("")

#Import the X-XSRF-Token returned from RememberMeController/ping into the request headers
xsrfToken = pingResponse.headers.get("X-XSRF-TOKEN")

#HTTP request header
header = {"Content-Type" : "application/json", "X-XSRF-TOKEN" : xsrfToken}
url=base_url + smsConfigurationID + '/execute'
response = my_session.get(url_execute, headers=header).json() 

Sample Response

The result returns a string integer with the execution id.


In case of error, no id is returned in the response parameters and the request has failed without activation of the message or voucher. More information on the issue can be derived by the HTTP response. (e.g. HTTP 400, 414 etc.)

Back to Top