Certify
Manually certifies a user against a course, learning path, or other supported resource, returning the resulting certificate record
Manually certifies a user against a course, learning path, or other supported resource, returning the resulting certificate record.
POST
https://example.thoughtindustries.com/incoming/v2/users/:id/certifyExample request
curl -X POST "https://example.thoughtindustries.com/incoming/v2/users/:id/certify" \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"userId": "00000000-0000-0000-0000-000000000000",
"resourceType": "string",
"resourceId": "00000000-0000-0000-0000-000000000000",
"expirationDate": "string"
}'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
id | string | Yes | path | The id identifier. |
userId | uuid | Yes | body | Unique identifier of the user to certify. |
resourceType | CertificateResourceType | Yes | body | The type of resource the certificate is issued against (e.g., course, learning path). |
resourceId | uuid | Yes | body | Unique identifier of the resource the certificate is issued against. |
expirationDate | ISO 8601 timestamp | No | body | Date and time at which the certificate expires, as an ISO 8601 timestamp. |
sendEmail | boolean | No | body | When true, sends a certificate notification email to the user. |
issuedAt | ISO 8601 timestamp | No | body | Date and time the certificate was issued, as an ISO 8601 timestamp. Defaults to the current time if omitted. |
recertificationDate | ISO 8601 timestamp | No | body | Date and time by which the user must recertify, as an ISO 8601 timestamp. |
Example response
{
"data": {
"APICertifyUser": {
"id": "00000000-0000-0000-0000-000000000000",
"certificateTemplate": {
"id": "00000000-0000-0000-0000-000000000000",
"resource": null,
"resourceType": "course",
"title": "string",
"asset": "https://example.com/path",
"supplementalAssets": [
"https://example.com/path"
],
"expirationDate": "2024-01-01T00:00:00.000Z",
"expirationDays": 0,
"recertificationAction": "resetProgress",
"recertificationInstructions": "string",
"recertificationActionText": "string",
"recertificationActionUrl": "https://example.com/path",
"recertificationAutoReset": true,
"recertificationAfterDays": 0,
"userCustomField": {
"id": "00000000-0000-0000-0000-000000000000",
"label": "string",
"slug": "example-slug",
"choices": {},
"ref": 0,
"required": true,
"type": "dropDown"
},
"userCustomFieldSlug": "example-slug",
"userCustomFieldValue": "string",
"customCss": "string",
"labels": [
{
"id": "00000000-0000-0000-0000-000000000000",
"certificateFieldId": "00000000-0000-0000-0000-000000000000",
"certificateField": {
"...": "..."
},
"x": 0,
"y": 0,
"textAlign": "left",
"fontSize": 0,
"fontColor": "#000000"
}
],
"isExpired": true,
"assetLibraryId": "00000000-0000-0000-0000-000000000000"
},
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"firstName": "string",
"abbreviatedName": "string",
"asset": "string",
"lastName": "string",
"name": "string",
"lastActiveAt": "2024-01-01T00:00:00.000Z",
"bio": "string",
"twoFactorEnabled": true,
"firstInitial": "string",
"lastInitial": "string",
"invitedByName": "string",
"shouldHighlight": true,
"purchasedCourses": [
{
"course": {
"...": "..."
},
"courseId": "00000000-0000-0000-0000-000000000000",
"certificate": "00000000-0000-0000-0000-000000000000",
"certificateIssuedAt": "2024-01-01T00:00:00.000Z",
"instructorAccessPurchased": true,
"status": "string"
}
],
"purchasedBundles": [
{
"bundle": {
"...": "..."
},
"bundleId": "00000000-0000-0000-0000-000000000000"
}
],
"activeLicense": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"label": "string",
"sku": "string",
"client": {
"...": "..."
},
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"accessDays": 0,
"expirationDate": "2024-01-01T00:00:00.000Z",
"seatsLimit": 0,
"dashboardLayoutId": "00000000-0000-0000-0000-000000000000",
"enableBranding": true,
"schoolName": "string",
"isDefault": true,
"learningPaths": [
{
"...": "..."
}
],
"learningPathIds": [
"00000000-0000-0000-0000-000000000000"
],
"appearance": {
"...": "..."
},
"courses": [
{
"...": "..."
}
],
"courseIds": [
"00000000-0000-0000-0000-000000000000"
],
"courseTags": [
{
"...": "..."
}
],
"courseTagIds": [
"00000000-0000-0000-0000-000000000000"
],
"parentLicense": {
"...": "..."
},
"parentLicenseId": "00000000-0000-0000-0000-000000000000",
"childLicenses": [
{
"...": "..."
}
],
"ref1": "string",
"ref2": "string",
"ref3": "string",
"ref4": "string",
"ref5": "string",
"ref6": "string",
"ref7": "string",
"ref8": "string",
"ref9": "string",
"ref10": "string"
},
"allocatedLicenses": [
{
"license": {
"...": "..."
},
"licenseRole": "student",
"licenseId": "00000000-0000-0000-0000-000000000000",
"status": "string"
}
],
"allocatedLearningPaths": [
{
"learningPath": {
"...": "..."
},
"learningPathId": "00000000-0000-0000-0000-000000000000",
"status": "string"
}
],
"attendedMeetings": [
{
"attendanceDate": "2024-01-01T00:00:00.000Z",
"user": {
"...": "..."
},
"meeting": {
"...": "..."
}
}
],
"waitlistedCourses": [
{
"course": {
"...": "..."
},
"courseId": "00000000-0000-0000-0000-000000000000"
}
],
"adminClients": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"schoolName": "string",
"courses": [
{
"...": "..."
}
],
"learningPaths": [
{
"...": "..."
}
],
"learningPathIds": [
"00000000-0000-0000-0000-000000000000"
],
"courseIds": [
"00000000-0000-0000-0000-000000000000"
],
"courseTags": [
{
"...": "..."
}
],
"courseTagIds": [
"00000000-0000-0000-0000-000000000000"
],
"purchasableContentIds": [
"00000000-0000-0000-0000-000000000000"
],
"purchasableTagIds": [
"00000000-0000-0000-0000-000000000000"
],
"purchasableTags": [
{
"...": "..."
}
],
"licenseEndDate": "2024-01-01T00:00:00.000Z",
"primaryLicense": {
"...": "..."
},
"dashboardLayoutId": "00000000-0000-0000-0000-000000000000",
"panorama": true,
"emailLayout": {
"...": "..."
},
"appearance": {
"...": "..."
},
"catalog": {
"...": "..."
},
"sku": "string",
"slug": "example-slug",
"customHost": "string",
"sso": {
"...": "..."
},
"redemptionLayoutId": "00000000-0000-0000-0000-000000000000",
"pendingJobs": [
{
"...": "..."
}
],
"seatsAllocatedCount": 0,
"seatsLimit": 0,
"seatsUsedCount": 0,
"tags": [
{
"...": "..."
}
],
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"licenses": [
{
"...": "..."
}
],
"licenseTree": [
{
"...": "..."
}
],
"currentUserManagerAllocatedLicenseTree": [
{
"...": "..."
}
],
"notificationEmails": "string",
"enableSegmentation": true,
"enableDiscussions": true,
"enableCommunitiesSegmentation": true,
"enableBranding": true,
"enableEcommerce": true,
"enableOnboardingSurvey": true,
"enableRecommendationAssessment": true,
"enableGlobalLinks": true,
"enableNavLinks": true,
"enableContentDetailPage": true,
"enableLicenseDashboards": true,
"enableCustomEmailSettings": true,
"disabled": true,
"clientSubscriptionNeedsSetup": true,
"defaultLanguage": "string",
"languageSelectorEnabled": true,
"languages": [
"string"
],
"autoFilterForSelectedLanguage": true,
"secretKey": "string",
"enableCreditPurchasing": true,
"currentBalance": 0,
"startingBalance": 0,
"allocatedCredits": 0,
"clientAdminAllocatableLearningPaths": [
"00000000-0000-0000-0000-000000000000"
]
}
],
"roleKey": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string",
"telephone": "string",
"stripeCustomerId": "00000000-0000-0000-0000-000000000000",
"externalCustomerId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"sfAccountId": "00000000-0000-0000-0000-000000000000",
"sfContactId": "00000000-0000-0000-0000-000000000000",
"shippingName": "string",
"client": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"schoolName": "string",
"courses": [
{
"...": "..."
}
],
"learningPaths": [
{
"...": "..."
}
],
"learningPathIds": [
"00000000-0000-0000-0000-000000000000"
],
"courseIds": [
"00000000-0000-0000-0000-000000000000"
],
"courseTags": [
{
"...": "..."
}
],
"courseTagIds": [
"00000000-0000-0000-0000-000000000000"
],
"purchasableContentIds": [
"00000000-0000-0000-0000-000000000000"
],
"purchasableTagIds": [
"00000000-0000-0000-0000-000000000000"
],
"purchasableTags": [
{
"...": "..."
}
],
"licenseEndDate": "2024-01-01T00:00:00.000Z",
"primaryLicense": {
"...": "..."
},
"dashboardLayoutId": "00000000-0000-0000-0000-000000000000",
"panorama": true,
"emailLayout": {
"...": "..."
},
"appearance": {
"...": "..."
},
"catalog": {
"...": "..."
},
"sku": "string",
"slug": "example-slug",
"customHost": "string",
"sso": {
"...": "..."
},
"redemptionLayoutId": "00000000-0000-0000-0000-000000000000",
"pendingJobs": [
{
"...": "..."
}
],
"seatsAllocatedCount": 0,
"seatsLimit": 0,
"seatsUsedCount": 0,
"tags": [
{
"...": "..."
}
],
"createdAt": "2