API referenceEngagements
Email a period's service report
Needs a token with the write:engagements scope. Authentication
Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.
POST
Emails the service report PDF. Recipients default to the client's email address; 422 validation_failed when none is valid. 503 mail_unavailable when email is not set up. Cannot be undone and a retry sends the email again.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
id*stringThe engagement's id.
period_id*stringThe period's id, from list_engagement_periods.
application/json- body
to?array<>Default: the client's email address.
Items
items <= 10cc?array<>Items
items <= 10subject?|Length
length <= 200message?|Length
length <= 5000OK
application/json- response
data*curl -X POST 'https://app.helvetly.com/api/v1/engagements/string/periods/string/report/send' \ -H 'Content-Type: application/json' \ -d '{ "to": [ "accounts@example.com" ], "message": "Please find the service report attached."}'Example Response
{ "data": { "to": [ "string" ] }}