Skip to main content
PATCH
Editar certificado

Escopo

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string

Nome do certificado exibido no painel do produtor

Maximum string length: 255
status
enum<string>

Status atual do certificado

  • draft - Rascunho
  • active - Ativo
  • inactive - Inativo
  • manual-review - Revisão manual
  • deleted - Excluído
Available options:
draft,
active,
inactive,
manual-review,
deleted
emission_type
enum<string>

Se o certificado é emitido automaticamente pelo gatilho ou manualmente pelo produtor

  • automatic - Automática
  • manual - Manual
Available options:
automatic,
manual
trigger_type
enum<string>

Condição que dispara a emissão do certificado

  • course-completion - Conclusão de curso
  • manual-issue - Emissão manual
Available options:
course-completion,
manual-issue
trigger_label
string

Texto exibido no painel para o gatilho do certificado

Maximum string length: 255
trigger_rules
any
text
string | null
Maximum string length: 5000
course_title
string | null
Maximum string length: 255
theme
enum<string>

Tema visual do certificado

  • white - Claro
  • dark - Escuro
Available options:
white,
dark
font_family
string

Família da fonte usada no certificado

Maximum string length: 100
primary_color
string

Cor principal do certificado no formato hexadecimal #RRGGBB ou #RRGGBBAA

Maximum string length: 9
Pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
logomark_url
string | null
Maximum string length: 1024
use_logo_as_watermark
boolean

Indica se o logo também é usado como marca d'água

show_cactus_pattern
boolean

Indica se o padrão de cactos aparece no cabeçalho do certificado

include_signature
boolean

Indica se o certificado exibe a assinatura

signature_url
string | null
Maximum string length: 1024
signer_name
string | null
Maximum string length: 255
signer_initials
string | null
Maximum string length: 20
signer_role
string | null
Maximum string length: 255
member_area_section
string<uuid> | null

Response

id
string<uuid>
required
read-only

Identificador único do certificado no sistema

public_id
string
required
read-only

Código público do certificado, não sequencial

name
string
required

Nome do certificado exibido no painel do produtor

Maximum string length: 255
issued_count
integer
required
read-only
member_area_section_type
string | null
required
read-only
created_at
string<date-time>
required
read-only

Data de criação do certificado

updated_at
string<date-time>
required
read-only

Data de atualização do certificado

status
enum<string>

Status atual do certificado

  • draft - Rascunho
  • active - Ativo
  • inactive - Inativo
  • manual-review - Revisão manual
  • deleted - Excluído
Available options:
draft,
active,
inactive,
manual-review,
deleted
emission_type
enum<string>

Se o certificado é emitido automaticamente pelo gatilho ou manualmente pelo produtor

  • automatic - Automática
  • manual - Manual
Available options:
automatic,
manual
trigger_type
enum<string>

Condição que dispara a emissão do certificado

  • course-completion - Conclusão de curso
  • manual-issue - Emissão manual
Available options:
course-completion,
manual-issue
trigger_label
string

Texto exibido no painel para o gatilho do certificado

Maximum string length: 255
trigger_rules
any
text
string | null
Maximum string length: 5000
course_title
string | null
Maximum string length: 255
theme
enum<string>

Tema visual do certificado

  • white - Claro
  • dark - Escuro
Available options:
white,
dark
font_family
string

Família da fonte usada no certificado

Maximum string length: 100
primary_color
string

Cor principal do certificado no formato hexadecimal #RRGGBB ou #RRGGBBAA

Maximum string length: 9
Pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
logomark_url
string | null
Maximum string length: 1024
use_logo_as_watermark
boolean

Indica se o logo também é usado como marca d'água

show_cactus_pattern
boolean

Indica se o padrão de cactos aparece no cabeçalho do certificado

include_signature
boolean

Indica se o certificado exibe a assinatura

signature_url
string | null
Maximum string length: 1024
signer_name
string | null
Maximum string length: 255
signer_initials
string | null
Maximum string length: 20
signer_role
string | null
Maximum string length: 255
member_area_section
string<uuid> | null