Deactivate Cardholder

šŸ”’

Required scope: members:write

The API credential calling this endpoint must be granted the members category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Deactivate a cardholder and terminate all active cards of that cardholder. You can optionally specify that the e-mail address of the cardholder should be modified by adding a suffix to it. This allows to re-invite the same e-mail address to a new cardholder.

Path Params
uuid
required

The unique identifier of the cardholder.

Query Params
uuid
required

The unique identifier of the organization.

Body Params
string

The suffix to add to the e-mail address of the cardholder. If null is provided, the e-mail address will not be modified.

Responses
204

Cardholder successfully deleted!

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json