API Reference

Krystal Identity API

Resources & Endpoints

Send e-mail

Sends an e-mail to the authenticated user.

POST
https://identity.krystal.io/api/v1/emails

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

properties Required

EmailProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

validation_error

An error ocurred with the input provided

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    email: Email {
        id: String
        subject: String
        recipients: [ EmailRecipient {
            id: String
            state: String
            delivered_at: Unix Timestamp?
        } ]
    }
}