Create a report email subscription

POST/report-email-subscriptions

This endpoint allows you to subscribe to receive a scheduled report by email. Idempotent - subscribing to an existing (report_type, frequency) returns the existing subscription.

Body application/json

report_type"fp_account_statement"required

Report type. Allowed values: fp_account_statement.

frequency"daily" | "monthly"required

Schedule cadence.

Response

Created

idstring<uuid>
report_type"fp_account_statement"
frequency"daily" | "monthly"
created_atstring<date-time>
updated_atstring<date-time>

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X POST "https://api.uat.triple-a.io/api/fiat-payout/v1/report-email-subscriptions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "report_type": "fp_account_statement",
  "frequency": "daily"
}'
Response
{
  "id": "00000000-0000-0000-0000-000000000000",
  "report_type": {},
  "frequency": {},
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}