Delivery Notes

Update a delivery note public link

Enable/disable the public share link of a delivery note or change its expiry. Returns 422 expiry_exceeds_max_days if the requested expiry exceeds the plan-enforced max_days. Supports Idempotency-Key for safe retries.

patch/companies/{company}/delivery-notes/{delivery_note}/public-link

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/delivery-notes/{delivery_note}/public-link
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

delivery_notestring uuid required

Public identifier (UUID v7) of the delivery note.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

action'revoke' | 'activate' | 'extend' | 'reset' required
extend_daysinteger

Response

Updated state of the delivery note public link after applying the requested action (revoke, activate, extend or reset). Returns the canonical url, whether the link is enabled, its expires_at and the plan max_days cap.

Example response

{
  "data": {
    "object": "public_link",
    "url": "https://app.factuarea.com/p/quotes/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a04",
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a04",
    "enabled": true,
    "expires_at": "2026-04-15T23:59:59Z",
    "max_days": 180
  }
}

Changes

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