Refresh saved patent family
refresh_patent_familyUpdates family grouping for one saved own patent using public patent information and related own patents already saved in the connected organisation. Useful for an apparent missing relationship, an unfinished family update, or a requested check against newer public information. Imports already attempt family grouping automatically; routine refresh after import is unnecessary. Related publications must be imported separately before they can be included. Repeating import_patent only retrieves its saved outcome. Existing family relationships are retained, so refresh cannot remove incorrect relationships. Patent text, PDFs, images, legal status and own/competitor classification are unchanged. Competitor records are not supported. Returns counts of added and existing relationships, unresolved or ambiguous matches, and failures, with warnings. It does not return a list of family members. A null links result means the update did not finish; repeating the refresh attempts it again. Results do not establish complete family coverage.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | Saved own patent document ID from import_patent, or document:<id> from search |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| links | Yes | ||
| status | Yes | ||
| warnings | Yes | ||
| documentId | Yes | ||
| refreshedAt | Yes | ||
| childReferences | Yes | ||
| parentReferences | Yes | ||
| publicationNumber | Yes |