POST Api/Mailer/Registration
Send an registration confirmation e-mail to the applicant.
Request Information
URI Parameters
None.
Body Parameters
with information about registration confirmation message
RegistrationMailParameterName | Description | Type | Additional information |
---|---|---|---|
ApplicantId |
ID of the applicant the e-mail should be sent to. |
integer |
None. |
Url |
The current applicant portal URL (if applicable). This is used to match for applicant portal settings. If empty or no match can be found, the default applicant portal settings will be used. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ApplicantId": 1, "Url": "sample string 2" }
application/xml, text/xml
Sample:
<RegistrationMailParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters"> <ApplicantId>1</ApplicantId> <Url>sample string 2</Url> </RegistrationMailParameter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Mail Status
MailerResponseName | Description | Type | Additional information |
---|---|---|---|
Status |
Status of the out-of-workflow mail action. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Status": true }
application/xml, text/xml
Sample:
<MailerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses"> <Status>true</Status> </MailerResponse>