create_badge
Create customizable digital badge templates with custom fields, branding, and optional expiration dates for issuing certificates and credentials.
Instructions
Create a new badge template with optional custom fields and branding. This badge can then be issued to recipients.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| badge_logo_path | No | Path to badge logo file (jpeg,png,jpg,gif,svg, max 2MB) | |
| comment | No | Additional comments or notes about the badge | |
| custom_fields | No | Custom fields for this badge (e.g., completion date, score, instructor) | |
| description | Yes | Badge description (e.g., "Awarded for completing the full-stack web development course") | |
| expire_date | No | Badge expiration date in YYYY-MM-DD format (optional) | |
| idempotency_key | Yes | Unique key to prevent duplicate badge creation (e.g., "badge_webdev_2024_001") | |
| issuing_organization_name | Yes | Name of the issuing organization (e.g., "Tech Academy") | |
| left_panel_description | No | Additional description for the left panel of the certificate | |
| name | Yes | Badge name (e.g., "Web Development Certificate") | |
| nickname | No | Optional badge nickname or short name | |
| organization_id | No | Existing organization ID (optional, will create new organization if not provided) |
Input Schema (JSON Schema)
{
"properties": {
"badge_logo_path": {
"description": "Path to badge logo file (jpeg,png,jpg,gif,svg, max 2MB)",
"type": "string"
},
"comment": {
"description": "Additional comments or notes about the badge",
"type": "string"
},
"custom_fields": {
"description": "Custom fields for this badge (e.g., completion date, score, instructor)",
"items": {
"properties": {
"name": {
"description": "Field name (e.g., \"Completion Date\")",
"type": "string"
},
"required": {
"default": false,
"description": "Whether this field is required when issuing the badge",
"type": "boolean"
},
"type": {
"default": "text",
"description": "Field type",
"enum": [
"text",
"email",
"number",
"date"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "Badge description (e.g., \"Awarded for completing the full-stack web development course\")",
"type": "string"
},
"expire_date": {
"description": "Badge expiration date in YYYY-MM-DD format (optional)",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
"idempotency_key": {
"description": "Unique key to prevent duplicate badge creation (e.g., \"badge_webdev_2024_001\")",
"type": "string"
},
"issuing_organization_name": {
"description": "Name of the issuing organization (e.g., \"Tech Academy\")",
"type": "string"
},
"left_panel_description": {
"description": "Additional description for the left panel of the certificate",
"type": "string"
},
"name": {
"description": "Badge name (e.g., \"Web Development Certificate\")",
"type": "string"
},
"nickname": {
"description": "Optional badge nickname or short name",
"type": "string"
},
"organization_id": {
"description": "Existing organization ID (optional, will create new organization if not provided)",
"type": "string"
}
},
"required": [
"name",
"description",
"issuing_organization_name",
"idempotency_key"
],
"type": "object"
}