API Reference

candidate.addEmailMessage

post
https://api.ashbyhq.com/candidate.addEmailMessage

Attaches an existing email message (e.g. fetched from a partner provider) to a candidate.

Requires the candidatesWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The candidate to attach this email to

string
required

Unique identifier for this message in the partner system. Must be unique per API key.

string
required

The email subject line

string
required

The sender email address

string
required

The recipient email address

string
required

The html body of the email

The Ashby user ID to associate with this email. Defaults to the API key user.

When the email was sent. Defaults to the current time.

CC recipients

URL to view the message in the partner application

RFC 5322 message identifier

Thread identifier to group this message with others. Defaults to emailProviderEmailId.

Whether the email should be marked as private. Private emails require "Allow access to non-offer private fields?" API key permission to create and view. Defaults to false.

Response

Updated 2 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago