latestOpenAPI 3.0.32026-08-10362374.4 KB
98c494325aae
Detail
Add Detail
Creates a detail.
Details for the body of the request:
- type enum value, the type of event which the credential is being issued for
- title the credential title
- description the credential description
- Duration the duration of the event
- The duration is a combination of two fields durationNumber and durationType
- durationNumber indicates the integer value for the durationType enum value which is the unit time
- cost enum value, the cost of the event or course
- Expire Date expire date of the credential, not required
- There are two different options for the expire date of the credential
- Set an exact expire date for every credential sent with this Detail (ex: 01/01/2023). This option uses expireDate (DateTime) field
- Set a time span which will be added to the credential's issue date (ex: 2 years). This option uses expireDateNumber (int) and expireDateType (DurationType enum) fields
- If none of these options are used, the expire date will be set to null
- If the expire date is set, you have the option of customizing your expiry date reminder email schedule. With the expiryReminderDays field, you can send how many days before the expire date you want reminders to be sent by email to the recipient.
- You can set a maximum of 3 reminder emails
- The field is a list of int, where each integer corresponds to the count of days before the expire date. So for example [1, 2, 4] means that an email will be sent 1 day, 2 days and 4 days before the credential expires.
- There are two different options for the expire date of the credential
- level enum value, level of the event or course
- earningCriteria the information given as earning criteria for the course or event, not required
- The input can be given as HTML code, the HTML will be rendered in the credential verification page below the "Earning Criteria" title
- skills the skills related to the Detail, minimum one skill is required for the status to be Ready
- The skills can be obtained from the /SearchSkills address
- The skillId field can be retrieved from the /SearchSkills address, this field can be left blank to add custom skills to the Detail
- languageCode has to be en or tr
- The skills can be obtained from the /SearchSkills address
- dontSendExpireDateEmail field is a boolean field used for controlling if users should be notified automatically when the expire date of credential is approaching
post/detail
Headers
api-versionstring required
The API version. Current version is 3.3. This value has to be set in every request.
Request body
Response
Successful response