API Reference

candidate.addEmailMessage

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

Adds an email message to a candidate's profile.

Requires the candidatesWrite permission.

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.

uuid

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

date-time

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

string

CC recipients.

uri

URL to view the message in the partner application.

string

RFC 5322 message identifier.

string

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

boolean
Defaults to false

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 22 days ago

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