Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Work Orders

Send work order as an email

post/workorders/{id}/emails

Path parameters

idinteger required

Global ID of the work order

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Request body

emailsstring[]

Emails to send the Work Order to

customMessagestring nullable

Custom message to send with the Work Order

Example request

{
  "emails": [
    "example@gmail.com"
  ],
  "customMessage": "This is a custom message",
  "exportOptions": {
    "attachments": true,
    "comments": true,
    "costs": "DETAILED",
    "procedureFormat": "DETAILED",
    "images": "FULL_SIZE",
    "includeBasicInformation": true,
    "includeExportInformation": true,
    "includeLocationAddress": true,
    "includedCustomFields": [
      "customField1"
    ],
    "priority": true,
    "qrCode": true,
    "signatureBox": true,
    "vendorInformation": true,
    "vendors": true,
    "workOrderInfo": true
  }
}

Response

Successfully created the email

idinteger

Global ID of the work order

Example response

{
  "id": 12345
}