Token payroll

Send Bulk Payment Confirmation Email

Sends payment confirmation emails for several settlement orders of a payroll and logs each send.

POSThttps://api.toku.com/stablecoin-payroll/send-bulk-payment-confirmation-email

Not available to API keys yet. It will need payroll:write.

curl --request POST \
  --url 'https://api.toku.com/stablecoin-payroll/send-bulk-payment-confirmation-email' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tokenPayrollID": "string",
  "settlementOrderIDs": [
    "string"
  ]
}'
200 response
{
  "success": true,
  "message": "string",
  "emailsSent": 0,
  "errors": [
    "string"
  ]
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Body

application/json

tokenPayrollIDstringrequired
settlementOrderIDsstring[]required

Response

200Successful response
successbooleanrequired
messagestringrequired
emailsSentintegerrequired
errorsstring[]required
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits