Saltar al contenido
memberfy
es-ar

Atualiza products

PUT/api/products/{id}

Auth
Requiere token
Quién puede:
owner
admin
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Owner ou admin. Aceita `directLinkEnabled` (boolean opcional) para ligar ou desligar a compra por link direto de um produto avulso; omitido, mantém o valor atual. `prerequisiteGroupIds` (array de UUID opcional) substitui os planos que o adicional exige; `[]` limpa, omitido mantém. Mesmas validações da criação: grupo de outra comunidade ou grupo em que o produto está dá 400. A resposta traz `prerequisiteGroupIds`. **Obsoleto na escrita (F-37):** prefira `addOnProductIds` no plano; este campo continua aceito e gravando. `commitmentMonths` (1 a 36, ou `null` para tirar o contrato) muda a duração do contrato (F-35); omitido, mantém. É conferido contra o produto depois da atualização: só `SUBSCRIPTION` `MONTHLY` (senão 400, `param = commitmentMonths`). Vale para assinaturas novas e para a renovação do contrato das existentes; uma assinatura feita sem contrato continua sem. `installmentInterestPayer` (`BUYER` ou `ORGANIZATION`; F-43): quem paga os juros de parcelamento no cartão. Ausente não muda. **`status: ACTIVE` é publicar** e segue as regras de `POST .../publish`: sem informações comerciais `APPROVED`, 403 com a mensagem traduzida que aponta onde preenchê-las; com a moeda do produto diferente da do país aprovado, 400 (`param = currency`). As mesmas regras valem ao trocar `currency` de um produto já `ACTIVE`. Editar qualquer outro campo, de rascunho ou de produto no ar, não exige aprovação.

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Cuerpo de la solicitud application/json

NombreTipoDescripción
titleopcionalstring
descriptionopcionalstringHTML.
shortDescriptionopcionalstring
internalNameopcionalstringNome visto só pela equipe.
bannerUrlopcionalstring (uri)
featuredImageUrlopcionalstring (uri)
slugopcionalstring
typeopcionalSUBSCRIPTION | ONE_TIME | INSTALLMENT
priceopcionalnumber≥ 0.01
billingIntervalopcionalHOURLY | DAILY | WEEKLY | MONTHLY | YEARLYSó para `SUBSCRIPTION`.
trialDaysopcionalinteger≥ 0, ≤ 365
requiresCardForTrialopcionalboolean
allowCancellationopcionalboolean
commitmentMonthsopcionalintegerFidelidade (F-35). Só `SUBSCRIPTION` `MONTHLY`. · ≥ 1, ≤ 36
installmentsopcionalintegerPara `INSTALLMENT`. · ≥ 2, ≤ 24
installmentPriceopcionalnumber≥ 0.01
allowedPaymentMethodsopcionalstring[]Métodos aceitos no checkout, como `CREDIT_CARD`, `PIX` e `BOLETO`.
maxInstallmentsopcionalinteger≥ 1, ≤ 12
installmentInterestPayeropcionalBUYER | ORGANIZATION
feePayeropcionalORGANIZATION | BUYER
accessDurationopcionalintegerDias de acesso; ausente = vitalício. · ≥ 1
hasStockopcionalboolean
stockQuantityopcionalinteger≥ 0
isHighlightedopcionalboolean
directLinkEnabledopcionalboolean
sortOrderopcionalinteger≥ 0
spaceIdsopcionalstring (uuid)[]
subscriptionGroupIdsopcionalstring (uuid)[]
prerequisiteGroupIdsopcionalstring (uuid)[]Obsoleto na escrita (F-37); prefira `addOnProductIds` no plano.
thankYouMessageopcionalstringmax 5000
redirectUrlopcionalstring (uri)
metadataopcionalobject

Respuestas

CódigoDescripción
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Ejemplo con curl

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