com.atproto.admin.sendEmail

POST /xrpc/com.atproto.admin.sendEmail

This endpoint is part of the atproto PDS management APIs. Requests usually require admin authentication and are made directly to the PDS instance.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Send email to a user's account email address.

Request

required

recipientDid didrequired

content stringrequired

subject string

senderDid didrequired

comment string

Additional comment by the sender that won't be used in the email itself but helpful to provide more context for moderators/reviewers

Schema

sent booleanrequired

{
  "sent": true
}

Bad Request

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken]

message stringrequired

{
  "error": "InvalidRequest",
  "message": "string"
}

Unauthorized

Schema

error required

message stringrequired

{
  "message": "string"
}