Sign in
latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Detail

Update Detail

Update a Detail with the id, placed in the parameters. Only the provided fields in the request body will be updated, the rest will remain unchanged. If skills are provided, old skills will be deleted and new skills will be created in place.

If Detail status is Sent, it can not be updated. You can copy the Detail with the /Copy address if you wish to use an edited version of the original 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
      1. Set an exact expire date for every credential sent with this Detail (ex: 01/01/2023). This option uses expireDate (DateTime) field
      2. 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
  • 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
  • dontSendExpireDateEmail field is a boolean field used for controlling if users should be notified automatically when the expire date of credential is approaching
put/detail/{detail_id}

Path parameters

detail_idstring required

ID of the Detail

Headers

api-versionstring required

The API version. Current version is 3.3. This value has to be set in every request.

Request body

typeinteger

Detail type enum (0=Field Event, 1=Online Event, 2=Class Course, 3=Online Course, 4=Webinar, 5=Achievement, 6=License, 7=Appreciation, 8=Promotional Course, 9=Membership, 10=Graduation, 11=Hybrid Event, 12=Hybrid Course)

titlestring
descriptionstring
durationNumberinteger
durationTypeinteger

Duration type enum (1=Hour, 2=Day, 3=Week, 4=Month, 5=Year, 6=Minute)

costinteger

Cost enum (0=Free, 1=Paid, 2=NA)

expireDatestring date nullable
expireDateNumberinteger nullable
expireDateTypeinteger nullable

DurationType enum value

levelinteger

Level enum (0=Beginner, 1=Intermediate, 2=Advanced, 3=Experienced, 4=Professional, 5=NA)

earningCriteriastring nullable

Earning criteria, can be HTML

dontSendExpireDateEmailboolean
expiryReminderDaysinteger[]

List of days before expire date to send reminders (max 3)

Response

Successful response

messagestring nullable
hasErrorboolean
validationErrorsstring[]
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","nullable":true}