PartnerCentralBenefits / Client / cancel_benefit_application

cancel_benefit_application¶

PartnerCentralBenefits.Client.cancel_benefit_application(**kwargs)¶

Cancels a benefit application that is currently in progress, preventing further processing.

response = client.cancel_benefit_application(
    Catalog='string',
    ClientToken='string',
    Identifier='string',
    Reason='string'
)

Parameters:

Catalog (string) –
[REQUIRED]

The catalog identifier that specifies which benefit catalog the application belongs to.
ClientToken (string) –
[REQUIRED]

A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.
Identifier (string) –
[REQUIRED]

The unique identifier of the benefit application to cancel.
Reason (string) – A descriptive reason explaining why the benefit application is being cancelled.

Return type:

dict

Returns:

{}