ACaccredible
Credentials

Create a New Credential

Changed on

You create a Credential with optional EvidenceItems and References using this action. Please make sure that you've created a group on your dashboard before creating a Credential. If you haven't then create a group in the dashboard or use this API request.

This endpoint requires a JSON object containing a Credential.

Important: If you don't have enough credits when attempting to create Credentials with this endpoint, your credentials will still be created in your account, but will not be published. This will save your data and prevent you from having to re-attempt your request later. You will be able to publish the created credentials in your account when you have the required credits

Creating Credentials - Video Walkthrough

post/v1/credentials

Request

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

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 required

The name of the recipient the credential is issued to.

recipient.emailstring required

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 required

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.

privateboolean

Whether to make credential private. When it is set to true, the Credential will be private and visible only to its recipient who has signed into credential.net. If no value is set, the default value will be automatically assigned based on Group.generate_private_credential and Department.generate_private_credential. Department.generate_private_credential will be used as the default when Group.generate_private_credential is set to null. Group.generate_private_credential will override Department.generate_private_credential and be used as the default when it is set to true or false.

approveboolean

Whether to publish credential at the time of creation. By default this is true but settings at dashboard for sandbox_mode take precendence.

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