Create an email

This endpoint lets you create a new email for a given candidate_reference.

For example, it may be useful if you send emails through an external service and you want to consolidate all the emails related to your candidates in our ATS.

email creation

POST https://www.welcomekit.co/api/v1/external/emails

Query Parameters

Name	Type	Description
candidate_reference*	string	Candidate reference
subject*	string	Email subject
body*	string	Email body (plain text, markdown, html)
from_email*	string	Email sender
to*	string	Email receiver
send_email	string	Let Welcome Kit send the related email to the candidate?
remote_file_urls	array	Email attachments (PDF, JPG, etc.)

200 Success

{
  "id": 12345,
  "subject": "Greetings",
  "body": "Email body",
  "from_email": "[email protected]",
  "to": "[email protected]",
  "created_at": "2018-01-03T16:17:07.501+01:00",
  "origin": "api",
  "candidate_reference": "wttj-d655345409a6097309156b05",
  "attachments": [
    {
      "filename": "resume",
      "file_url": "http://example.com/resume.pdf",
      "size": 433348,
      "content_type": "application/pdf"
    }
  ]
}

Request example

curl -X POST "https://www.welcomekit.co/api/v1/external/emails" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WK_API_KEY" \
    -d @- <<EOF
{
  "candidate_reference": "wttj-d655345409a6097309156b05",
  "subject": "Greetings",
  "body": "Email body",
  "from_email": "[email protected]",
  "to": "[email protected]",
  "remote_file_urls": [
    {
      "filename": "resume",
      "url": "http://example.com/resume.pdf"
    }
  ]
}
EOF