Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.78 KB

GDPRApi.md

File metadata and controls

62 lines (43 loc) · 1.78 KB

Yoast\MyYoastApiClient\GDPRApi

All URIs are relative to https://my.yoast.test

Method HTTP request Description
deleteCustomer DELETE /api/Customers/{id}/gdpr-delete Performs a "GDPR forget me" request.

deleteCustomer

string deleteCustomer($id)

Performs a "GDPR forget me" request.

Deletes and/or obfuscates all data related to a customer, except order data that we legally need to generate invoices.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\GDPRApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 

try {
    $result = $apiInstance->deleteCustomer($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GDPRApi->deleteCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

string

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]