Internships manager

Internships manager

  • Docs
  • API
  • Tuto
  • Help
  • GitHub

›Services API

Introduction

  • Internships manager API

REST API

  • Businesses
  • Campaigns
  • Files
  • Internships
  • InternshipTypes
  • Mentors
  • Mentoring propositions
  • Statistics
  • Students

Services API

  • Emails
  • Statistics

Emails

Details of methods to handle emails service

sendWelcome(to: string, locale?: string)

This method is used to send a welcome message to our new user

Params

KeyTypeOptionalDescription
tostringnoDest user email
localestringyeslanguage to use in email (e.g.: 'fr')

Return

This method return a Promise

  • On resolve, you could catch sended email
  • On reject, you could catch the error encountred

sendCampaignsCreate(to: string, campaigns: Campaigns, locale?: string)

This method is used to send a notification message to mentors when a campaign is created

Params

KeyTypeOptionalDescription
tostringnoDest user email
campaignsstringnoInstance of the created campaigns
localestringyeslanguage to use in email (e.g.: 'fr')

Return

This method return a Promise

  • On resolve, you could catch sended email
  • On reject, you could catch the error encountred
← StudentsStatistics →
  • sendWelcome(to: string, locale?: string)
    • Params
    • Return
  • sendCampaignsCreate(to: string, campaigns: Campaigns, locale?: string)
    • Params
    • Return
Copyright © 2019 ENIB