POST Api/Mailer/DoubleOptIn?culture={culture}

Send a double-opt-in message to the possible applicant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
culture

The culture that should be used for double-opt-in e-mail.

 string

Required

Body Parameters

with information about the DOI request

DoubleOptInParameter
NameDescriptionTypeAdditional information
Email

The applicant's e-mail address.

 string

None.
FirstName

The applicant's firstname.

 string

None.
LastName

The applicant's last name.

 string

None.
DoubleOptInToken

The double-opt-in verification token for the applicant.

 string

None.
JobId

The job ID the applicant has been trying to apply 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: 
{
  "Email": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "DoubleOptInToken": "sample string 4",
  "JobId": 1,
  "Url": "sample string 5"
}

application/xml, text/xml

Sample: 
<DoubleOptInParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <DoubleOptInToken>sample string 4</DoubleOptInToken>
  <Email>sample string 1</Email>
  <FirstName>sample string 2</FirstName>
  <JobId>1</JobId>
  <LastName>sample string 3</LastName>
  <Url>sample string 5</Url>
</DoubleOptInParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Mail Status

MailerResponse
NameDescriptionTypeAdditional 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>