ACaccredible
Groups

Clone a Group

Changed on

You can clone a group using this action. Add attributes to override cloned values. Cloning a group only works when certificate or badge designs are within the same department as the original group.

A clone always mirrors the original Group's skills framework. Every framework skill on the original is copied to the clone at the same position in the framework, and skill_framework_version_id and framework_skills sent in the request body are ignored — you cannot clone a Group onto a different framework. To change the clone's skills, clone it first and then update it.

If the original Group's framework version has been retired — or its framework is mid-retirement for the original Group's Department, in which case the version itself still reads as active — the clone is created without a framework and a 207 is returned. Re-version the framework first if you need the skills copied.

post/v1/issuer/groups/{group_id}/clone

Request

  • Base URL
    https://api.accredible.com
  • URL
    https://api.accredible.com/v1/issuer/groups/{group_id}/clone
  • Auth
    API key in header Authorization

Request body

namestring

Name of the group (for your reference and never shown to the recipient). Copy will be added to the beginning of name of the new cloned group when a new name is not provided.

course_namestring

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

course_descriptionstring

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.

certificate_design_idnumber

Certificate Design which the Group will use to display Credentials. Certificate design needs to exist in the newly cloned space.

badge_design_idnumber

Badge Design which the Group will use to display Credentials. Badge design needs to exist in the newly cloned space.

primary_design_idnumber

Primary Design which the Group will use to display Credentials.

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.

learning_outcomesunknown
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 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.

auto_expiry_unit'years' | 'months'

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

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 the cloned 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

Changes

  • 60f9caaace27Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • dc79460d9222Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the success response with the status