---
title: "Create a certificate"
method: POST
path: "/api/v1/certificates"
tags: ["Certificates"]
---

# Create a certificate

`POST /api/v1/certificates`

## Request body

- object
  - `certificate` object
    - `listing_id` integer, required — Id of the listing
    - `name` string, required — Name of the certificate
    - `active` boolean — State of the certificate (default: true)
    - `template` string, required — Template for certificate contents
    - `pdf_settings` object — PDF settings
      - `orientation` string — 'Landscape' or 'Portrait' (default: Landscape)
  - `days_to_expire` integer — Days until expiry after award; mutually exclusive with expires_at
  - `expires_at` string — Fixed expiry datetime; mutually exclusive with days_to_expire

## Response `201`

certificate created

- object
  - `certificate` object, required
    - `id` integer, required — Certificate ID
    - `listing_id` integer, required — Corresponding listing ID
    - `name` string, required — Certificate name
    - `active` boolean, required — Whether the certificate is enabled
    - `template` string, required — HTML template used to generate issued certificates
    - `pdf_settings` object, required — Extra params for PDF generation
      - `orientation` string — 'Landscape' or 'Portrait'
    - `created_at` string, required — Creation timestamp (ISO 8601)
    - `updated_at` string, required — Last-updated timestamp (ISO 8601)
    - `days_to_expire` integer, nullable — Days until an issued certificate expires
    - `expires_at` string, nullable — Fixed datetime when issued certificates expire

---

[API](https://skmtc.net/instructure/apis/canvas-catalog-api.md) · [All operations](https://skmtc.net/instructure/apis/canvas-catalog-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instructure/canvas-catalog-api/revisions/78578cd3e37a/schema)