ChangeOrders

Email a change order to the customer

Emails the change order PDF to the given recipients and marks it sent. Same delivery pipeline as the product's send action. Requires change_orders:send. Set requestSignature to true to include a signing link in that same email. That also requires the signatures:send scope, a signer name, and e-signature to be enabled for the organization. The signer email defaults to the project contact, then the first To address. Approved, rejected, and voided change orders cannot be sent for signature; a plain email of those change orders is still allowed. The response includes signatureRequested and, when a request was created, signatureRequestId. It never includes a signing URL or recipient token.

post/change-orders/{id}/send

Request

  • Base URL: https://app.buildworkpro.com/api/v1
  • URL: https://app.buildworkpro.com/api/v1/change-orders/{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
requestSignatureboolean

When true, this send also starts an e-signature and the email includes the signing link. Defaults to false. Also requires the signatures:send scope and a signer name.

signerEmailstring email

Signer email. Defaults to the project contact's email, then the first To address. Must be one of the recipients.

signerNamestring

Signer name. Required when requestSignature is true.

Response

Sent

Changes

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