function MCAPI::apikeyExpire in Mailchimp 5

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::apikeyExpire()
2. 6.2 MCAPI.class.php \MCAPI::apikeyExpire()
3. 6 MCAPI.class.php \MCAPI::apikeyExpire()
4. 7 MCAPI.class.php \MCAPI::apikeyExpire()

Expire a Specific API Key. Note that if you expire all of your keys, a new, valid one will be created and returned next time you call login(). If you are trying to shut off access to your account for an old developer, change your MailChimp password, then expire all of the keys they had access to. Note that this takes effect immediately, so make sure you replace the keys in any working application before expiring them! Consider yourself warned...

Related

@example xml-rpc_apikeyExpire.php

Parameters

string $username Your MailChimp user name:

string $password Your MailChimp password:

Return value

boolean true if it worked, otherwise an error is thrown.

File

./MCAPI.class.php, line 990

Class

MCAPI

Code

function apikeyExpire($username, $password) {
  $params = array();
  $params["username"] = $username;
  $params["password"] = $password;
  return $this
    ->callServer("apikeyExpire", $params);
}