PUT
/api/v2/vouchers/{id}/status/{status}PUT /api/v2/vouchers/{id}/status/{status}
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id (path) | string (uuid) | Yes | |
| status (path) | string | Yes | |
| Idempotency-Key (header) | string | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| GroupId | string (uuid) | Yes | |
| Name | string | Yes | |
| Description | string | Yes | |
| MaskedCode | string | Yes | |
| Type | string | Yes | |
| Value | unknown | Yes | |
| Currency | string | Yes | |
| Status | string | Yes | |
| SuccessfulUses | unknown | Yes | |
| ReservedUses | unknown | Yes | |
| PerUserLimit | unknown | Yes | |
| MaximumTotalUses | unknown | Yes | |
| RedeemedValue | unknown | Yes | |
| ReservedValue | unknown | Yes | |
| MaximumAggregateValue | unknown | Yes | |
| RequiresWhitelabelApproval | boolean | Yes | |
| RequiresEmail2Fa | boolean | Yes | |
| ValidFrom | string (date-time) | Yes | |
| ValidUntil | string (date-time) | Yes | |
| CreatedAt | string (date-time) | Yes | |
| PlaintextCode | string | No |
Example request
curl -X PUT "https://{base_url}/api/v2/vouchers/{id}/status/{status}" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.