Skip to main content
POST
/
orders
/
{id}
/
notify
curl -X POST 'https://app.filemonk.io/api/v1/external/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/notify' \
  -H 'X-Auth-Token: fm_api_key_your_key_here' \
  -H 'Content-Type: application/json'

curl -X POST 'https://app.filemonk.io/api/v1/external/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/notify' \
  -H 'X-Auth-Token: fm_api_key_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{ "email": "alternate@example.com" }'

const orderId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';

// Send to customer email on file
const response = await fetch(
  `https://app.filemonk.io/api/v1/external/orders/${orderId}/notify`,
  {
    method: 'POST',
    headers: {
      'X-Auth-Token': 'fm_api_key_your_key_here',
      'Content-Type': 'application/json'
    }
  }
);
const data = await response.json();

import requests

order_id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'

# Send to customer email on file
response = requests.post(
    f'https://app.filemonk.io/api/v1/external/orders/{order_id}/notify',
    headers={'X-Auth-Token': 'fm_api_key_your_key_here'}
)
data = response.json()

{
  "order": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "#1042",
    "email": "customer@example.com",
    "phone": "+1234567890",
    "financial_status": "paid",
    "fulfillment_status": null,
    "total_price": "29.99",
    "currency": "USD",
    "created_at": "2026-03-01T14:30:00Z",
    "download_count": 0
  },
  "notified": true,
  "notified_at": "2026-05-26T08:45:00Z"
}

{
  "error": "Order not found"
}

{
  "error": "Order has no customer email. Provide an email parameter."
}
Beta. The order notification endpoint is in active development. The request and response shapes shown here are stable for production use, but we may add new fields or capabilities without notice. Contact support to be notified of breaking changes.
Send (or re-send) the download notification email for an order. This triggers the same email the customer receives when Filemonk processes an order automatically — including the download link, any attached assets, and licence keys. The notification email uses the template configured in your Filemonk email settings. If the order has already been notified, calling this endpoint sends the email again (useful when you’ve added new files to the order).

​
Path parameters

​
id
string
required
The order’s unique identifier (UUID).

​
Request body

​
email
string
Override the recipient email address. When omitted, the email is sent to the customer email on file for the order. Useful when the order has no email or you want to send to a different address.

​
Response

​
order
object
required
The order object.
​
notified
boolean
required
true when the notification was successfully queued.
​
notified_at
string
required
ISO 8601 timestamp of when the notification was sent.
curl -X POST 'https://app.filemonk.io/api/v1/external/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/notify' \
  -H 'X-Auth-Token: fm_api_key_your_key_here' \
  -H 'Content-Type: application/json'

curl -X POST 'https://app.filemonk.io/api/v1/external/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/notify' \
  -H 'X-Auth-Token: fm_api_key_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{ "email": "alternate@example.com" }'

const orderId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';

// Send to customer email on file
const response = await fetch(
  `https://app.filemonk.io/api/v1/external/orders/${orderId}/notify`,
  {
    method: 'POST',
    headers: {
      'X-Auth-Token': 'fm_api_key_your_key_here',
      'Content-Type': 'application/json'
    }
  }
);
const data = await response.json();

import requests

order_id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'

# Send to customer email on file
response = requests.post(
    f'https://app.filemonk.io/api/v1/external/orders/{order_id}/notify',
    headers={'X-Auth-Token': 'fm_api_key_your_key_here'}
)
data = response.json()

{
  "order": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "#1042",
    "email": "customer@example.com",
    "phone": "+1234567890",
    "financial_status": "paid",
    "fulfillment_status": null,
    "total_price": "29.99",
    "currency": "USD",
    "created_at": "2026-03-01T14:30:00Z",
    "download_count": 0
  },
  "notified": true,
  "notified_at": "2026-05-26T08:45:00Z"
}

{
  "error": "Order not found"
}

{
  "error": "Order has no customer email. Provide an email parameter."
}