---
title: "Update a Credential"
method: PUT
path: "/v1/credentials/{id}"
tags: ["Credentials"]
---

# Update a Credential

`PUT /v1/credentials/{id}`

[Updating Credentials - Video Walkthrough](https://www.loom.com/share/4940d9cf43da43dc870f40ac4dd3831f?sid=ebfe460c-01a1-40a0-b5fe-6e8d13386f54)

## Path parameters

- `id` string, required

## Request body

- object
  - `id` string — The unique ID of the credential. If you supply your own internal ID we'll use this as a reference for the Credential. If not we'll assign an ID.
  - `recipient.name` string — The name of the recipient the credential is issued to.
  - `recipient.email` string — The recipient's email address.
  - `recipient.phone_number` string — The recipient's phone number in E.164 format (e.g., +14155552671). This field is optional and available as part of the Growth plan. Phone numbers are used for SMS campaigns and are associated with the credential.
  - `recipient.id` string — The recipient's user ID as defined by your organization. This alllows you to easily map your recipients to their Credentials regardless of changes to their email address.
  - `recipient.meta_data` object — 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.
  - `group_id` number — Group Id to which the credential should belong.
  - `name` string — The Credential/course name displayed to recipients. This is required if the Group the Credential belongs to doesn't have a Course Name set.
  - `description` string — The credential/course description displayed to recipients. This is required if the Group the Credential belongs to doesn't have a Course Description set.
  - `custom_attributes` object — Custom variables to display on the Credential. These should be added to the design using the visual editor. Data should be formatted as a JSON hash where keys are the custom attribute names and the values are the values to be displayed on the Credential.
  - `issued_on` string — Date of issue, the default is when the credential is created. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)
  - `expired_on` string — Date you would like the credential to expire on, null by default. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)
  - `complete` boolean — Whether the achievement is complete or still in progress, true by default.
  - `allow_supplemental_evidence` boolean — Whether to allow recipients to add their own supplemental evidence to the Credential, true by default.
  - `allow_supplemental_references` boolean — Whether to allow recipients to add their own supplemental references to the credential, true by default.
  - `evidence_items` unknown
  - `references` unknown
  - `meta_data` object — 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.

## Response `200`

OK

---

[API](https://skmtc.net/accredible/apis/accredible-credential-api.md) · [All operations](https://skmtc.net/accredible/apis/accredible-credential-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/accredible/accredible-credential-api/versions/56b317c13686/schema)