Pular para o conteúdo
memberfy
pt-br

Edita um modelo

PUT/api/certificates/templates/{id}

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Se o modelo já emitiu, `version` sobe; os certificados emitidos guardam a cópia do modelo usado e não mudam. Um modelo ativo que fique sem os campos obrigatórios volta a rascunho.

Parâmetros

NomeOndeTipoDescrição
idobrigatóriopathstring (uuid)

Headers

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

Corpo da requisição application/json

NomeTipoDescrição
nameopcionalstringNome interno do modelo.
slugopcionalstringEndereço estável do modelo, para outros módulos (gatilhos de curso e evento) apontarem para ele sem o id. Gerado do nome na criação quando não vier; editável; único na comunidade; minúsculas, números e hífens. Renomear o modelo não muda o slug. Inválido ou já usado: 400 com `param: slug`. · max 60
titleopcionalstringTítulo impresso ("Certificado de conclusão").
descriptionopcionalstringAceita {nome}, {assunto} e {cargaHoraria} ({curso} e {evento} continuam valendo, como apelidos de {assunto}). Trecho entre colchetes é opcional: `concluiu[ {assunto}], com…` some quando a variável dentro dele está vazia. Fora de colchetes, a oração (entre vírgulas) com uma variável vazia é omitida, exceto a primeira, onde só a variável sai.
workloadHoursopcionalnumber
languageopcionalstringNasce com o idioma da comunidade.
timezoneopcionalstringFuso IANA da data impressa.
signersopcionalobject[]
signers[].nameobrigatóriostring
signers[].roleopcionalstring
signers[].signatureImageUrlopcionalstringURL devolvida pelo upload de assinatura.
layoutopcionalobject[]Só no tipo IMAGE.
layout[].keyobrigatóriorecipientName | issuedAt | qr | title | description | workload | subjectTitle | code | signer1 | signer2
layout[].boxobrigatórioobject
layout[].box.xopcionalnumber≥ 0, ≤ 100
layout[].box.yopcionalnumber≥ 0, ≤ 100
layout[].box.wopcionalnumber≥ 0.1, ≤ 100
layout[].box.hopcionalnumber≥ 0.1, ≤ 100
layout[].fontopcionalinter | montserrat | lora | playfair-display | eb-garamond | great-vibes | noto-sansObrigatório fora do `qr`.
layout[].weightopcional400 | 700
layout[].sizeopcionalnumber% da altura da página (6 ≈ 36 pt).
layout[].minSizeopcionalnumberO texto encolhe até aqui antes de quebrar em duas linhas.
layout[].coloropcionalstring
layout[].alignopcionalleft | center | right
layout[].valignopcionaltop | middle | bottom
layout[].uppercaseopcionalboolean

Respostas

CódigoDescrição
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.

Exemplo com curl

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