Aller au contenu

Altera a configuração de créditos

PUT/api/credits/settings

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
Clé d’API:
sales:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Só owner e admin (os demais: 403). Atualização parcial: só os campos enviados mudam. Vale da próxima virada do mês em diante e nunca altera um lote que já existe. Valor inválido (teto negativo, ciclos menor que 1...): 400 com `errors[].param` no campo.

En-têtes

NomTypeDescription
If-Unmodified-SincefacultatifstringOpcional: a versão lida (`updatedAt` de `GET /api/credits/settings`), como data HTTP, se não vier `updatedAt` no corpo. Outra gravação depois dela responde 409.
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

NomTypeDescription
rolloverEnabledfacultatifboolean
rolloverCapfacultatifinteger≥ 0
rolloverMaxCyclesfacultatifinteger≥ 1, ≤ 12
prorateFirstMonthfacultatifboolean
changeWindowHoursfacultatifinteger≥ 0, ≤ 720
lateCancelLosesCreditsfacultatifboolean
noShowLosesCreditsfacultatifboolean
expiryNoticeDaysfacultatifinteger≥ 0, ≤ 30

Réponses

StatutDescription
200Configuração salva
400Requisição inválida — falha de validação.
403Autenticado, mas sem permissão para esta operação.
409Outra gravação veio antes da versão enviada (`updatedAt` no corpo ou `If-Unmodified-Since`); `data.updatedAt` é a versão atual: recarregue e repita. Cada gravação avisa os editores abertos (`item.saved`, ver `POST /api/realtime/ticket`).

Exemple curl

curl -X PUT "https://api.memberfy.net/api/credits/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'