Atualiza coupons
PUT/api/coupons/{id}
- Auth
- Requires a token
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
codeoptional | string | |
nameoptional | string | |
descriptionoptional | string | |
discountValueoptional | number | |
maxDiscountoptional | number | |
trialExtensionDaysoptional | integer | |
durationoptional | ONCE | FOREVER | REPEATING | |
durationInMonthsoptional | integer | |
maxUsesoptional | integer | |
maxUsesPerUseroptional | integer | |
startDateoptional | string (date-time) | |
endDateoptional | string (date-time) | |
minPurchaseAmountoptional | number | |
applicableProductsoptional | —[] | |
excludedProductsoptional | —[] | |
applicableToOneTimeoptional | boolean | |
applicableToSubscriptionoptional | boolean | |
applicableToInstallmentoptional | boolean | |
isStackableoptional | boolean | |
statusoptional | ACTIVE | INACTIVE |
Responses
| Status | Description |
|---|---|
200 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
curl example
curl -X PUT "https://api.memberfy.net/api/coupons/<id>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'