API: Unsubscribe from an Event

Once unsubscribed from an event the callback URL will no longer be called upon that event.

Before using this call, you'll need to authenticate against the API as detailed in Making your first call to the Project API.

All of these examples have simulation mode turned on. Once you are ready to use in a production environment, you can remove the simulation parameter. Any changes will then affect your account.

 

PHP

Python

Response

 

PHP

$nonce = get_nonce('https://api.elucidat.com/v2/event/unsubscribe', 'PUBLIC KEY', 'PRIVATE KEY');
$headers = auth_headers('PRIVATE KEY', $nonce);
$fields = array(
'simulation_mode'=>'simulation',
'event'=>$arg1,
'callback_url'=>$arg2);
$result = call_elucidat($headers, $fields, 'POST', 'https://api.elucidat.com/v2/event/unsubscribe', 'PRIVATE KEY');
echo ("HTTP status code: " . $result['status'] . "\n");
print_r($result['response']);

Python 3.9

     endpoint = '/v2/event/unsubscribe'
     method = 'POST'
     params = {}
     data = {'event': 'arg1',
             'callback_url': 'arg2',
'simulation_mode': 'simulation'} api = Api(api_root, endpoint, method, params, data, private_key, public_key) api.call_elucidat()

Response

{
"message": "Unsubscribed from event"
}

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

Request support
Access support that’s tailored to you by getting in touch with our Support Team.
Send us feedback
Do you have a new feature request, or want to tell us about something that works well (or not so well) for you? Get in touch!