ProvisioningUsersApi.md

Yoast\MyYoastApiClient\ProvisioningUsersApi

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

Method	HTTP request	Description
scheduleDelete	POST /api/provisioning/user/schedule-delete	Schedule a delete for a subscription

scheduleDelete

\Yoast\MyYoastApiClient\Model\SubscriptionProvisioningResponseDto scheduleDelete($body)

Schedule a delete for a subscription

Schedules a customer for gdpr delete.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Yoast\MyYoastApiClient\Api\ProvisioningUsersApi(
    // 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()
);
$body = new \Yoast\MyYoastApiClient\Model\ScheduleDeleteUserDto(); // \Yoast\MyYoastApiClient\Model\ScheduleDeleteUserDto | 

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

Parameters

Name	Type	Description	Notes
body	\Yoast\MyYoastApiClient\Model\ScheduleDeleteUserDto

Return type

\Yoast\MyYoastApiClient\Model\SubscriptionProvisioningResponseDto

Authorization

No authorization required

HTTP request headers

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

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