ACaccredible
Credentials

Update a Credential

Changed on

Updating Credentials - Video Walkthrough

put/v1/credentials/{id}

Request

  • Base URL
    https://api.accredible.com
  • URL
    https://api.accredible.com/v1/credentials/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

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.

Request body

idstring

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

The name of the recipient the credential is issued to.

recipient.emailstring

The recipient's email address.

recipient.phone_numberstring

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

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

group_idnumber

Group Id to which the credential should belong.

namestring

The Credential/course name displayed to recipients. This is required if the Group the Credential belongs to doesn't have a Course Name set.

descriptionstring

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_attributesobject

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_onstring

Date of issue, the default is when the credential is created. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)

expired_onstring

Date you would like the credential to expire on, null by default. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)

completeboolean

Whether the achievement is complete or still in progress, true by default.

allow_supplemental_evidenceboolean

Whether to allow recipients to add their own supplemental evidence to the Credential, true by default.

allow_supplemental_referencesboolean

Whether to allow recipients to add their own supplemental references to the credential, true by default.

evidence_itemsunknown
referencesunknown
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.

Response

OK

Changes

  • f494f7d36307Revision changes
    • info

      added the new optional request property

  • cac96b8772c3Revision changes
    • breaking

      the path request parameter id became required

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional