Programs

Update a program. Roles: admin.

Changed on
put/api/certs/{certId}

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/certs/{certId}
  • Auth
    AuthToken (a scheme the document does not define)

Path parameters

certIdinteger required

Request body

membershipIdinteger required
namestring required
typeCode'CERTIFICATION' | 'CHALLENGE' | 'MEMBERSHIP' | 'PASS' required
programCategoryIdinteger
completionStrategy'ALL_PREREQ_COMPLETE' | 'ANY_PREREQ_COMPLETE' | 'EARNED_REQUIRED_POINTS' required
renewalStrategy'ALL_PREREQ_COMPLETE' | 'ANY_PREREQ_COMPLETE' | 'EARNED_REQUIRED_POINTS' required
shortDescriptionstring
descriptionstring
requiredboolean
imageUuidstring uuid
allowAdminEnrollboolean
allowSelfEnrollboolean
autoEnrollEnabledboolean
autoRenewalEnabledboolean
certificateUuidstring uuid
certificatesEnabledboolean
enrollmentNotificationsEnabledboolean
completionNotificationsEnabledboolean
openDatestring date
closeDatestring date
activeboolean required
unlistedboolean required
termIntervalCode'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
termIntervalCountinteger
termStartCode'EARN' | 'ENROLL' | 'FIRST_EARN' | 'FIRST_ENROLL' | 'ANCHOR'
expireReminderDaysinteger
earlyRenewalDaysinteger
renewalGracePeriodDaysinteger
renewalAnchorDatestring date
creditsnumber
pointsRequirednumber float
renewalPointsRequirednumber float
emailCompletionBodystring
incompleteReminderIntervalDaysinteger
incompleteReminderCountMaxinteger
incompleteReminderBodystring
tierinteger required
benefitTypeCode'PHYSICAL' | 'VIRTUAL' | 'HYBRID' required
externalReferenceIdstring
contentIdsinteger[]

Response

OK

successboolean
errorstring

Changes

  • 6e5d224eed9bRevision changes
    • warning

      added the new AGE enum value to the // response property for the response status

    • warning

      added the new GREATER_THAN_OR_EQUALS enum value to the // response property for the response status

    • warning

      added the new LESS_THAN_OR_EQUALS enum value to the // response property for the response status

  • 887e7398ca4aRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status