Create a Group

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

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

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

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

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.

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

Enable or disable recording of these Credentials on a Blockchain.

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

Certificate Design which the Group will use to display Credentials.

Badge Design which the Group will use to display Credentials.

Primary Design which the Group will use to display Credentials.

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

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.

Specifies the number of years or months (see auto_expiry_unit) 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.

The unit of time for auto_expiry. Defaults to years if not supplied and auto_expiry exists.

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

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

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

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

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

ID of the skill category to associate with this group.

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

Id of the Skill Framework version to take skills from, as returned in a framework's versions array by View all Skill Frameworks. Must be sent together with framework_skills.

Omit both this and framework_skills to create a Group that uses free-text learning_outcomes instead.

This key is write-only. The response reports the Group's pinned version as skill_framework.version.id instead, and its skills as skills.