PayApps

Email a pay application to the customer

Emails the pay application PDF to the given recipients and marks it sent. Same delivery pipeline as the product's send action. Requires pay_apps:send.

post/pay-apps/{id}/send

Request

  • Base URL: https://app.buildworkpro.com/api/v1
  • URL: https://app.buildworkpro.com/api/v1/pay-apps/{id}/send
  • Auth: HTTP bearer

Path parameters

idinteger required

Headers

Idempotency-Keystring uuid

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request body

templateIdinteger
recipientEmailsstring[] required
ccstring[]
bccstring[]
subjectstring
bodystring

Response

Sent

Changes

No recorded changes to this operation across all 1 revision of this API.