Sign in
Credential Templates

Update a credential template

Updates the specified credential template (group) by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

<Callout title="Naming update" type="warn"> Groups are being renamed to Credential Templates to better reflect their purpose. This is a **naming update only** — all functionality remains the same.

During the transition, you may still see both terms used interchangeably across the API, app, and existing integrations. </Callout>

<Callout title="Legacy request shape" type="warn"> For backward compatibility, this endpoint still accepts the legacy `certificateDesignId` and `badgeDesignId` request fields for the time being. Those fields are deprecated, intentionally omitted from the request schema below, and may be removed without notice. Do not send both `designIds` and the legacy fields in the same request.

If you use the legacy request shape, the response will also temporarily include legacy certificateDesignId and badgeDesignId fields for compatibility. </Callout>

patch/v1/groups/{id}

Path parameters

idstring required

The unique ID of the credential template (group).

Example:01g90279gp5sbmfek7wymcsvec

The unique ID of the credential template (group).

Headers

Certifier-Versionstring required

API version header. Required for all requests.

Example:2022-10-26

API version header. Required for all requests.

Request body

namestring

The name of the credential template (group) that is used as [group.name] attribute later on

designIdsstring[]

Replaces the ordered list of design template IDs associated with the credential template.

learningEventUrlstring uri

The learning event's URL that is shown in the digital wallet

Example request

{
  "name": "Updated Financial Markets",
  "designIds": [
    "01fpwtztwf7sacca5r0c483mnm",
    "01hz2ej4yzdcfkq9fa78nhyj0x"
  ],
  "learningEventUrl": "https://www.coursera.org/learn/financial-markets-global"
}

Response

Credential template (group) updated successfully

idstring required

The unique identifier of the credential template (group).

namestring required

The name of the credential template (group) that is used as [group.name] attribute later on

learningEventUrlstring uri nullable required

The learning event's URL that is shown in the digital wallet

designIdsstring[] required

The ordered list of design template IDs associated with this credential template.

certificateDesignIdstring nullable required

Legacy field, to be removed. Returns the first ordered certificate design ID from designIds, or null when no certificate design is associated. Present only when the legacy request shape was used.

badgeDesignIdstring nullable required

Legacy field, to be removed. Returns the first ordered badge design ID from designIds, or null when no badge design is associated. Present only when the legacy request shape was used.

createdAtstring date-time required

The date and time when this credential template (group) was created. Formatted as an ISO 8601 date and time string

updatedAtstring date-time required

The date and time when this credential template (group) was updated. Formatted as an ISO 8601 date and time string

Example response

{
  "id": "01g90279gp5sbmfek7wymcsvec",
  "name": "Financial Markets",
  "learningEventUrl": "https://www.coursera.org/learn/financial-markets-global",
  "designIds": [
    "01fpwtztwf7sacca5r0c483mnm",
    "01hz2ej4yzdcfkq9fa78nhyj0x"
  ],
  "certificateDesignId": "01fpwtztwf7sacca5r0c483mnm",
  "badgeDesignId": "01hz2ej4yzdcfkq9fa78nhyj0x",
  "createdAt": "2022-01-01T00:00:00.000Z",
  "updatedAt": "2022-01-01T00:00:00.000Z"
}

Changes