Description
This endpoint allows you to create a new credential group in Hyperstack. A credential group acts as a template container that organizes credentials by program or course.
Bearer YOUR_API_TOKEN — obtainable from Hyperstack Dashboard → Settings → API Access
Body Parameters
Title of the credential group.
Description of the credential group.
The template key for the certificate. At least one of certificate_template or badge_template is required.
The template key for the badge. At least one of certificate_template or badge_template is required.
External URL associated with the credential group.
Tags related to the credential group.
A human-readable code for the group (e.g. CERT-2024). Alphanumeric, hyphens, and spaces only. Auto-generated if not provided.
Indicates whether credentials in this group expire. Defaults to false.
Validity period (in years) if does_expire is true.
Enables decentralized blockchain anchoring for credentials. Defaults to false.
Success Response Fields
Indicates whether the group creation was successful. Always true for a 200 response.
The unique key (ID) assigned to the newly created credential group.
Responses
200 Success
400 Bad Request
401 Unauthorized
{
"success" : true ,
"group_key" : "aBcDeFgHiJkL"
}
curl -X POST "https://api.thehyperstack.com/v1/groups/new" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Course Completion Certificate",
"description": "Awarded upon successful completion of the course.",
"certificate_template": "abcdefg",
"badge_template": "xyz",
"url": "https://acme.com/course",
"tags": ["apple", "mango", "orange"],
"group_code": "CERT-2024",
"does_expire": true,
"validity": 1,
"blockchain": true
}'