Skip to main content
POST
Update Credential Group

Description

Changes a credential group. Only the fields you send are changed. If the call returns an error, nothing is changed.

Headers

string
required
Your API key: Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.

Path Parameters

string
required
Key of the group to change.

Body Parameters

string
New title of the group.
string
New description of the group.
string
New web page for the group.
array[string] | string
New tags, as a list or a comma-separated string. They replace all the group’s tags.
string
New short code for the group. Characters other than letters, numbers, hyphens and spaces are removed. What is left must be 50 characters or fewer, or the call returns 400 with invalid_group_code. An empty string is ignored.
boolean
true to make credentials expire after validity years. false to make them never expire.If you send true without validity, credentials never expire.
number
How many years a credential is valid after it is published. Used only when you also send does_expire: true.
string
Key of a certificate design in your organization. The group’s credentials use this design from now on. An unknown key returns 400 with invalid_certificate_template.
string
Key of a badge design in your organization. The group’s credentials use this design from now on. An unknown key returns 400 with invalid_badge_template.
boolean
true to anchor credentials on the blockchain, false to stop. It only takes effect if your plan includes blockchain.
boolean
false to stop emailing recipients when their credential is published, true to email them.
A new expiry applies to credentials published after the change. Credentials already published keep their expiry date. To change one, use Update Credential.

Success Response Fields

boolean
true when the group was saved.

Responses

Last modified on October 20, 2026