---
title: "Update invoice public link"
method: PATCH
path: "/companies/{company}/invoices/{invoice}/public-link"
tags: ["Invoices"]
---

# Update invoice public link

`PATCH /companies/{company}/invoices/{invoice}/public-link`

## Request

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

Applies an action to the public link: `revoke`, `activate`, `extend` (with `extend_days`), or `reset` to the plan default.

## Path parameters

- `company` string, uuid, required
- `invoice` string, uuid, required

## Headers

- `Idempotency-Key` string
- `Factuarea-Version` string, date

## Request body

- UpdateInvoicePublicLinkRequest: Public REST API v1 — PATCH /v1/companies/{company}/invoices/{invoice}/public-link. `SchemaName` sets a unique, clean OpenAPI schema name (`UpdateInvoicePublicLinkRequest`), consistent with Quote/Proforma/DeliveryNote for the same operation, without renaming the class.
  - `action` 'revoke' | 'activate' | 'extend' | 'reset', required
  - `extend_days` integer

## Response `200`

- object
  - `data` PublicLink, required: Represents the state of the shareable public link of a document (quote/invoice/proforma/delivery_note). `url` is the absolute URL ready to send to the client; `enabled` indicates whether it is active; `expires_at` the deadline (`null` = unlimited); `max_days` the maximum allowed when extending it.
    - `object` 'public_link', required
    - `url` string, uri, required: Absolute URL of the public link to share with the client.
    - `id` string, required: UUID v7 of the document the link points to.
    - `enabled` boolean, required: Indicates whether the public link is currently active.
    - `expires_at` string, date-time, nullable, required: Expiration date/time of the link, or `null` if it does not expire.
    - `max_days` integer, required: Maximum number of days allowed when extending the link validity (business limit).

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `422`: Validation failed, or the invoice cannot undergo the requested state transition (e.g. marking an already-paid invoice as paid, or editing an issued invoice — use a corrective instead). The `error.param` field identifies which input is invalid, if any. Issuing or annulling an invoice can also be rejected with `verifactu_not_eligible`: either a field of the invoice does not fit its billing record, or — only when the company has VeriFactu enabled in NO VERI*FACTU mode — it has no usable signing certificate (`error.subcode: signing_certificate_unavailable`; `error.param` is `certificate`, `representation` or `system_certificate`, depending on what is missing); in both cases the invoice stays exactly as it was.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)