Skip to main content
POST
Email the rendered statement PDF to recipients
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required
statementId
string<uuid>
required

Body

application/json
recipients
string<email>[]
required
Minimum array length: 1
subject
string

Defaults to "Royalty Statement: ()".

message
string

Response

Email send result.

Standard server envelope used by the statement, reconciliation, sub-publishing, and analytics endpoints.

status
enum<string>
Available options:
success,
error
message
string
data
object