Auth & Identidade
Gestão de Acesso
Atualizar Voucher
curl --request PATCH \
--url https://api.example.com/organizations/{organizationId}/vouchers/{voucherId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"expiresAt": "<string>"
}
'{
"voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"externalRef": "ext_ref_abc123",
"name": "Updated Credit",
"amount": 10000,
"currency": "BRL",
"effectiveAt": "2026-01-01T00:00:00.000Z",
"expiresAt": "2027-06-30T23:59:59.000Z",
"amountRedeemed": 2500,
"status": "ACTIVE",
"createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"updatedAt": "2026-03-25T14:30:00.000Z",
"deletedBy": null,
"deletedAt": null
}
Vouchers
Atualizar Voucher
Atualizar descricao ou periodo de validade de um voucher.
PATCH
/
organizations
/
{organizationId}
/
vouchers
/
{voucherId}
Atualizar Voucher
curl --request PATCH \
--url https://api.example.com/organizations/{organizationId}/vouchers/{voucherId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"expiresAt": "<string>"
}
'{
"voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"externalRef": "ext_ref_abc123",
"name": "Updated Credit",
"amount": 10000,
"currency": "BRL",
"effectiveAt": "2026-01-01T00:00:00.000Z",
"expiresAt": "2027-06-30T23:59:59.000Z",
"amountRedeemed": 2500,
"status": "ACTIVE",
"createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"updatedAt": "2026-03-25T14:30:00.000Z",
"deletedBy": null,
"deletedAt": null
}
Requer permissao
voucher:write.Headers
Bearer token.
Parametros de Path
UUID da organizacao.
UUID do voucher.
Corpo da Requisicao
Updated expiration date.
Resposta
UUID do voucher.
UUID da organizacao.
Referencia externa.
Nome do voucher.
Valor do credito em centavos.
Codigo da moeda.
Data de vigencia.
Data de expiracao.
Valor resgatado em centavos.
Status do voucher.
Identificador do criador.
Timestamp de criacao.
Identificador do ultimo atualizador.
Timestamp da ultima atualizacao.
Deleter identifier.
Deletion timestamp.
{
"voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"externalRef": "ext_ref_abc123",
"name": "Updated Credit",
"amount": 10000,
"currency": "BRL",
"effectiveAt": "2026-01-01T00:00:00.000Z",
"expiresAt": "2027-06-30T23:59:59.000Z",
"amountRedeemed": 2500,
"status": "ACTIVE",
"createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"updatedAt": "2026-03-25T14:30:00.000Z",
"deletedBy": null,
"deletedAt": null
}
Exemplos de Codigo
curl -X PATCH https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/vouchers/019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"expiresAt": "2026-12-31T23:59:59.000Z"
}'
Codigos de Erro
| Status | Codigo | Descricao |
|---|---|---|
400 | validation_error | Entrada invalida ou campos obrigatorios ausentes |
401 | unauthorized | Autenticacao ausente ou invalida |
403 | forbidden | Permissoes insuficientes |
404 | organization.not_found | Organizacao nao encontrada |
404 | voucher.not_found | Voucher nao encontrado |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.