Skip to main content
POST
/
templates
Create certificate template
curl --request POST \
  --url https://api.hixbe.com/certify/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Hixbe-Version: <hixbe-version>' \
  --data '
{
  "name": "Professional Certification",
  "background_url": "https://example.com/certificates/professional-cert-bg.png",
  "fields": [
    "recipient_name",
    "course_title",
    "completion_date",
    "instructor_name"
  ]
}
'
{
  "id": "tmpl_1234567890abcdef",
  "name": "Professional Certification",
  "created_at": "2025-12-03T10:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Hixbe-Version
string
required

API version in YYYY-MM-DD format

Example:

"2026-01-01"

Body

application/json

Request payload for creating a new certificate template

​
name
string
required

Display name for the certificate template

Example:

"Professional Certification"

​
background_url
string<uri>
required

URL to the background image for the certificate

Example:

"https://example.com/certificates/professional-cert-bg.png"

​
fields
string[]

Array of field names that can be populated when issuing certificates

Example:
[
  "recipient_name",
  "course_title",
  "completion_date",
  "instructor_name"
]

Response

Certificate template created successfully

Response containing certificate template information

​
id
string

Unique identifier for the template

Example:

"tmpl_1234567890abcdef"

​
name
string

Display name of the template

Example:

"Professional Certification"

​
created_at
string<date-time>

Timestamp when the template was created

Example:

"2025-12-01T10:00:00Z"