Coorpacademy

Coorpacademy Email API

Transactional email service backed by Mandrill, exposing one operation per templated message the platform sends — onboarding, welcome, signup validation and self-validation, password reset, first-login attempt, course finished, adaptive course finished, trending and recommended courses, battle invitations and waiting-opponent notices, forum reply notifications, certification done, coach unlocked, we-miss-you re-engagement, scoped export links, SAP notifications, assistance requests, Go1 subscription requests and SCORM download links. 27 paths / 27 operations. Key-gated via an `Authorization` header.

GitHub OpenAPI

Documentation

📖
APIReference
https://api.coorpacademy.com/?urls.primaryName=api-mail

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/coorpacademy/refs/heads/main/openapi/coorpacademy-mail-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/coorpacademy/refs/heads/main/overlays/coorpacademy-mail-overlay.yaml

OpenAPI Specification

coorpacademy-mail-openapi.json Raw ↑ 
{"swagger":"2.0","info":{"description":"API to send emails with Mandrill","version":"1.0.0","title":"email API"},"securityDefinitions":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"}},"paths":{"/api/v1/trendingCourse":{"post":{"tags":["learner / bricklane"],"summary":"send trendingCourse email","description":"","operationId":"trendingCoursePOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/recommendedCourse":{"post":{"tags":["learner / bricklane"],"summary":"send recommendedCourse email","description":"","operationId":"recommendedCoursePOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/onboarding":{"post":{"tags":["learner / bricklane"],"summary":"send onboarding email","description":"","operationId":"onboardingPOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/finishCourse":{"post":{"tags":["learner / bricklane"],"summary":"send finishCourse email","description":"","operationId":"finishCoursePOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/CourseRef"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/skillToReview":{"post":{"tags":["review"],"summary":"send skill to review email","description":"send skill to review email","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/SkillRef"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/finishAdaptiveCourse":{"post":{"tags":["learner / mooc"],"summary":"send finishAdaptiveCourse email","description":"","operationId":"finishAdaptiveCoursePOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/ProgressionId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/passwordReset":{"post":{"tags":["learner / mooc"],"summary":"send passwordReset email","description":"","operationId":"passwordResetPOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/ResetLink"},{"$ref":"#/parameters/Expires"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/doBattle":{"post":{"tags":["learner / bricklane"],"summary":"send doBattle email","description":"","operationId":"doBattlePOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/doBattleOnCourse":{"post":{"tags":["learner / bricklane"],"summary":"send doBattleOnCourse email","description":"","operationId":"doBattleOnCoursePOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/CourseRef"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/othersProgress":{"post":{"tags":["learner / bricklane"],"summary":"send othersProgress email","description":"","operationId":"othersProgressPOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/AnsweredQuestions"},{"$ref":"#/parameters/ConnectedUsers"},{"$ref":"#/parameters/ViewedLessons"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/weMissYou":{"post":{"tags":["learner / bricklane"],"summary":"send weMissYou email","description":"","operationId":"weMissYouPOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/firstLoginAttempt":{"post":{"tags":["learner / mooc"],"summary":"send firstLoginAttempt email","description":"","operationId":"firstLoginAttemptPOST","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/Expires"},{"$ref":"#/parameters/LoginUrl"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/scopedExportLink":{"post":{"tags":["learner / mooc"],"summary":"send scopedExportLink email","description":"","operationId":"scopedExportLinkPost","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/ExportType"},{"$ref":"#/parameters/ExportFormat"},{"$ref":"#/parameters/ExportDate"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/battleWaitingOpponent":{"post":{"tags":["learner / mooc"],"summary":"send battleWaitingOpponent email","description":"","operationId":"battleWaitingOpponentPost","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/BattleId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/sendBattle":{"post":{"tags":["learner / mooc"],"summary":"send sendBattle email","description":"","operationId":"sendBattle","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/BattleId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/coachUnlocked":{"post":{"tags":["learner / mooc"],"summary":"send coachUnlocked email","description":"","operationId":"coachUnlocked","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/CourseRef"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/certificationDone":{"post":{"tags":["learner / mooc"],"summary":"send certificationDone email","description":"","operationId":"certificationDone","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/GoalLabel"},{"$ref":"#/parameters/Rewards"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/signupSelfValidation":{"post":{"tags":["personalHooks"],"summary":"send signupSelfValidation email","description":"","operationId":"signupSelfValidation","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/sapNotification":{"post":{"tags":["client / mooc"],"summary":"send sapNotification email","description":"","operationId":"sapNotification","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/RecipientAddress"},{"$ref":"#/parameters/Csv"},{"$ref":"#/parameters/LmsEndpoint"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/signupValidation":{"post":{"tags":["client / mooc"],"summary":"send signupValidation email","description":"","operationId":"signupValidation","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/RecipientAddress"},{"$ref":"#/parameters/UserId_"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/assistance":{"post":{"tags":["client / mooc & cockpit"],"summary":"send assistance email","description":"","operationId":"assistance","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/RecipientAddress"},{"$ref":"#/parameters/UserId_"},{"$ref":"#/parameters/SlideRef"},{"$ref":"#/parameters/Url"},{"$ref":"#/parameters/Object"},{"$ref":"#/parameters/Message"},{"$ref":"#/parameters/EngineRef"},{"$ref":"#/parameters/UniversalRef"},{"$ref":"#/parameters/ChapterId"},{"$ref":"#/parameters/Module"},{"$ref":"#/parameters/ExternalContentRef"},{"$ref":"#/parameters/Repository"},{"$ref":"#/parameters/Branch"},{"$ref":"#/parameters/PlatformName"},{"$ref":"#/parameters/UserName"},{"$ref":"#/parameters/UserEmail"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/signupComplete":{"post":{"tags":["learner / mooc"],"summary":"send signupComplete email","description":"","operationId":"signupComplete","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/welcome":{"post":{"tags":["learner / mooc"],"summary":"send welcome email","description":"","operationId":"welcome","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/Source"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/notifyAnswerOnForum":{"post":{"tags":["learner / mooc"],"summary":"send email notifying a reply on a forum post","description":"","operationId":"notifyAnswerOnForum","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/ParentPost"},{"$ref":"#/parameters/Post"},{"$ref":"#/parameters/Url"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/go1Subscription":{"post":{"tags":["coorpmanager"],"summary":"send go1 subscription request","description":"","operationId":"go1Subscription","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/UserId"},{"$ref":"#/parameters/RecipientAddress"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/contentScormLink":{"post":{"tags":["Content Scorm"],"summary":"send link to download Scorm file","description":"","operationId":"contentScormLink","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/BrandId"},{"$ref":"#/parameters/RecipientAddress"},{"$ref":"#/parameters/DownloadLink"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/mobileConnection":{"post":{"tags":["mobile"],"summary":"send mobileConnection email","description":"","security":[{"Authorization":[]}],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"$ref":"#/parameters/RecipientAddress"}],"responses":{"200":{"$ref":"#/responses/Success"},"500":{"$ref":"#/responses/InternalError"}}}}},"parameters":{"DownloadLink":{"name":"data[downloadLink]","in":"formData","description":"download link scorm file","required":true,"type":"string"},"BrandId":{"name":"brandId","in":"formData","description":"digital, up, onboarding etc.","type":"string","required":true},"UserId":{"name":"userId","in":"formData","description":"id from /api/v1/users/me","required":true,"type":"string"},"RecipientAddress":{"name":"recipientAddress","in":"formData","description":"an address mail","required":true,"type":"string"},"SkillRef":{"name":"data[skillRef]","in":"formData","required":true,"type":"string"},"CourseRef":{"name":"data[courseRef]","in":"formData","required":true,"type":"string"},"AnsweredQuestions":{"name":"data[answeredQuestions]","in":"formData","required":true,"type":"number"},"ConnectedUsers":{"name":"data[connectedUsers]","in":"formData","required":true,"type":"number"},"ViewedLessons":{"name":"data[viewedLessons]","in":"formData","required":true,"type":"number"},"ProgressionId":{"name":"data[progressionId]","in":"formData","required":true,"type":"string"},"LoginUrl":{"name":"data[loginUrl]","in":"formData","required":true,"type":"string"},"Expires":{"name":"data[expires]","in":"formData","required":true,"type":"string"},"ResetLink":{"name":"data[resetLink]","in":"formData","required":true,"type":"string"},"BattleId":{"name":"data[battleId]","in":"formData","required":true,"type":"string"},"ExportType":{"name":"data[type]","in":"formData","required":true,"type":"string"},"ExportDate":{"name":"data[date]","in":"formData","required":true,"type":"string"},"ExportDownloadUrl":{"name":"data[downloadUrl]","in":"formData","required":true,"type":"string"},"ExportFormat":{"name":"data[format]","in":"formData","required":true,"type":"string"},"GoalLabel":{"name":"data[goalLabel]","in":"formData","required":true,"type":"string"},"Rewards":{"description":"Labels of rewards. [\"str1\", \"str2\", \"str3\"]","name":"data[rewards]","in":"formData","required":true,"type":"array","items":{"type":"string"}},"UserId_":{"name":"data[userId]","in":"formData","required":true,"type":"string"},"SlideRef":{"name":"data[slideRef]","in":"formData","required":true,"type":"string"},"Url":{"name":"data[url]","in":"formData","required":true,"type":"string"},"Object":{"name":"data[object]","in":"formData","required":true,"type":"string"},"Message":{"name":"data[message]","in":"formData","required":true,"type":"string"},"ParentPost":{"name":"data[parentPost]","in":"formData","description":"Original post id on the forum","required":true,"type":"string"},"Post":{"name":"data[post]","in":"formData","description":"Id of the post containing the reply","required":true,"type":"string"},"EngineRef":{"name":"data[engineRef]","in":"formData","required":true,"type":"string"},"UniversalRef":{"name":"data[universalRef]","in":"formData","required":false,"type":"string"},"ChapterId":{"name":"data[chapterId]","in":"formData","required":false,"type":"string"},"Module":{"name":"data[module]","in":"formData","required":false,"type":"string"},"ExternalContentRef":{"name":"data[externalContentRef]","in":"formData","required":false,"type":"string"},"Csv":{"name":"data[csv]","in":"formData","required":false,"type":"string"},"LmsEndpoint":{"name":"data[lmsEndpoint]","in":"formData","required":false,"type":"string"},"Repository":{"name":"data[repository]","in":"formData","required":false,"type":"string"},"Branch":{"name":"data[branch]","in":"formData","required":false,"type":"string"},"PlatformName":{"name":"data[platformName]","in":"formData","required":false,"type":"string"},"UserName":{"name":"data[userName]","in":"formData","required":false,"type":"string"},"UserEmail":{"name":"data[userEmail]","in":"formData","required":false,"type":"string"},"Source":{"name":"data[source]","in":"formData","required":false,"type":"string","enum":["import","sso","signup"]}},"responses":{"Success":{"description":"Email sent successfully","schema":{"type":"object","properties":{"success":{"type":"object","properties":{"ResponseMetadata":{"type":"object","properties":{"RequestId":{"type":"string"}}},"MD5OfMessageBody":{"type":"string"},"MessageId":{"type":"string"}}}}}},"InternalError":{"description":"InternalError","schema":{"type":"string"}}},"basePath":"/mail","schemes":["https"]}