Delete Benefit

Delete a benefit.

[!WARNING] Every grants associated with the benefit will be revoked. Users will lose access to the benefit.

Scopes: benefits:write

DELETE /v1/benefits/{id}

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;

$sdk = Spaire\Spaire::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->benefits->delete(
    id: '<value>'
);

if ($response->statusCode === 200) {
    // handle response
}

403

{
  "error": "<string>",
  "detail": "<string>"
}

Authorizations

Authorization · string · header · required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

id · string<uuid4> · required

The benefit ID.

Response

204

Benefit deleted.