API Reference

Krystal Identity API

Resources & Endpoints

Send e-mail to organization

Sends an e-mail to all owners of a given organization.

POST
https://identity.krystal.io/api/v1/organizations/{organization}/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

organization Required

Organization Lookup None

properties Required

EmailProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

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?
        } ]
    }
}