Sign in

v27

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-01620431.2 KB
Groups

Create a Group

post/v1/issuer/groups

Request body

namestring required

Name of the group (for your reference and never shown to the recipient).

course_namestring required

Name of the course or achievement. This is visible to the recipient.

course_descriptionstring required

Description of the course or achievement. This is visible to the recipient.

course_linkstring

Link to the web page with information related to this Credential. Typically this is a course information or event information page.

languagestring

Language for the group. Currently we support "en", "es", "vi", "pt", "ja", "fr", "da", "nl", "fi", "no", "nb", "ro", "sv", "th", "tw", "zh", "tr", "ar", "he", "ms" and "de". Default language is en.

attach_pdfboolean

PDF of the Credential should be attached to email when recipient is informed. Default is false.

blockchainboolean

Enable or disable recording of these Credentials on a Blockchain.

design_idnumber

DEPRECATED. Certificate Design which the Group will use to display Credentials.

certificate_design_idnumber

Certificate Design which the Group will use to display Credentials.

badge_design_idnumber

Badge Design which the Group will use to display Credentials.

primary_design_idnumber

Primary Design which the Group will use to display Credentials.

department_idnumber

Department that the group belongs to. If not defined the group will be assigned to the organizations default department.

meta_dataobject

You can use this parameter to attach key-value strings to the object. Meta data is useful for storing additional, structured information on an object.

{"stackTrail":"paths:/v1/issuer/groups:post:requestBody:content:application/json:schema:properties:learning_outcomes","oasType":"schema","type":"unknown","description":"Searchable keywords identifying skills credential-holders need to demonstrate (or have learned) in the process of earning this credential."}
generate_private_credentialboolean

The default value of Credential.private for the Group. The supported values are true, false, and null. When this is set to true or false, it will override Department.generate_private_credential and be used as the default of Credential.private when creating a new Credential. When this is set to null, it won't override Department.generate_private_credential which will be used for the default of Credential.private instead.

auto_expirynumber

Specifies the number of years from the issue date after which the credential will automatically expire. If the specified value is less than or equal to 0, it will be ignored.

signup_urlstring

This provides a direct path for credential viewers to enroll in your course.

signup_url_showboolean

Show or hide the sign up url. The supported values are true, false and null.

course_link_showboolean

This links the credential data record to your information about the credential on your website. The supported values are true, false and null.

organization_link_showboolean

Show or hide the link to your website homepage. The supported values are true, false and null.

allow_duplicate_credentialsboolean

An email address can receive more than one credential. The supported values are true & false. Defaults to false.

skill_category_idnumber

ID of the skill category to associate with this group.

{"stackTrail":"paths:/v1/issuer/groups:post:requestBody:content:application/json:schema:properties:collections","oasType":"schema","type":"unknown","description":"Full list of collections to associate to this group"}
achievement_typestring

The type of achievement, for example 'Award' or 'Certification'. The supported values are listed here https://www.imsglobal.org/spec/ob/v3p0#achievementtype-enumeration

Response

OK