> ## Documentation Index > Fetch the complete documentation index at: https://newscatcherinc-docs.mintlify.site/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update entity > Updates one or more fields of an existing entity. ## OpenAPI ````yaml catch-all-api patch /catchAll/entities/{entity_id} openapi: 3.1.0 info: title: NewsCatcher CatchAll API version: 1.6.4 description: > CatchAll is a web search API that generates unique datasets that don't exist anywhere else on the web. Built on NewsCatcher's proprietary real-world event index, it delivers state-of-the-art recall—finding all relevant events, not just top results. ### Authentication All endpoints except /health and /version require `x-api-key` header. If the key is invalid or missing, the API returns the `403 Forbidden` error. ### Job workflow 1. (Optional) Get suggestions via /catchAll/initialize 2. Submit a query via /catchAll/submit with optional date ranges and custom validators/enrichments 3. Poll /catchAll/status/{job_id} until completed (10-15 minutes) 4. Retrieve results via /catchAll/pull/{job_id} ### Monitor workflow 1. Create successful job via /catchAll/submit 2. Create monitor via /catchAll/monitors/create with schedule 3. Retrieve aggregated results via /catchAll/monitors/pull/{monitor_id} ### Webhook workflow 1. Create a webhook via `POST /catchAll/webhooks` 2. Attach it to a job or monitor via `POST /catchAll/webhooks/{webhook_id}/resources`, or pass `webhook_ids` at job or monitor creation time 3. Receive HTTP notifications at the configured URL when each job completes ### Company search workflow 1. Create a dataset via `POST /catchAll/datasets/` or `POST /catchAll/datasets/upload` 2. Wait for the dataset `latest_status` to reach `ready` 3. Submit a job with `connected_dataset_ids` pointing to your dataset 4. Retrieve results — each record includes a `connected_entities` array with relevance scores per matched company ### Important notes **Dynamic schemas**: Response schemas are generated dynamically by LLMs. Field names in the `enrichment` object may vary and are not deterministic across jobs unless explicitly specified. contact: name: NewsCatcher url: https://newscatcherapi.com email: support@newscatcherapi.com servers: - url: https://catchall.newscatcherapi.com description: Production server security: - ApiKeyAuth: [] tags: - name: Jobs description: Operations to create, monitor, and retrieve job results. externalDocs: description: Learn about job lifecycle and status tracking url: >- https://www.newscatcherapi.com/docs/web-search-api/get-started/quickstart - name: Monitors description: Operations to create, operate and retrieve monitor results. externalDocs: description: >- Automate recurring queries with scheduled jobs and webhook notifications. url: >- https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/monitors - name: Webhooks description: > Operations to create and manage reusable webhook endpoints. A webhook is a named HTTP endpoint that receives a POST notification when a job or monitor completes. Create webhooks once at the organization level and attach them to any number of jobs or monitors via `webhook_ids`. Supports Slack, Microsoft Teams, and generic HTTP targets with configurable delivery modes, authentication, and headers. externalDocs: description: Learn about centralized webhooks and notification setup url: >- https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/webhooks - name: Entities description: > Operations to create, update, and delete company entities. Entities are the building blocks of Company Watchlist. Each entity represents a company (or person) you want to track. Add identifying information such as domain, alternative names, and key persons to improve matching quality. externalDocs: description: Learn about Company Watchlist and entities url: >- https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/company-search - name: Datasets description: > Operations to create and manage datasets of entities. A dataset is a named collection of entities — think of it as a watchlist or portfolio. Connect a dataset to a job via `connected_dataset_ids` to activate Company Watchlist. Datasets can be reused across multiple jobs and monitors. externalDocs: description: Learn about datasets and Company Watchlist url: >- https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/company-search - name: Projects description: | Operations to create, organize, and manage projects. A project is a named container for jobs, monitors, and datasets. Group related resources by use case, team, or client, and share them with teammates. Resources can be assigned at creation time or post-hoc. externalDocs: description: Learn about projects and resource organization url: >- https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/projects - name: Meta description: Operations to check API health and version. externalDocs: description: Find out more about NewsCatcher CatchAll API url: https://www.newscatcherapi.com/docs/web-search-api/get-started/introduction paths: /catchAll/entities/{entity_id}: patch: tags: - Entities summary: Update entity description: | Updates one or more fields of an existing entity. operationId: updateEntity parameters: - $ref: '#/components/parameters/EntityId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEntityRequest' example: description: Updated description additional_attributes: company_attributes: alternative_names: - NewsCatcher CatchAll - NewsCatcher API - NCA responses: '200': $ref: '#/components/responses/EntityResponse' '400': $ref: '#/components/responses/EntityBadRequestError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' components: parameters: EntityId: name: entity_id in: path required: true description: Unique entity identifier. schema: type: string format: uuid example: 854198fa-f702-49db-a381-0427fa87f173 schemas: UpdateEntityRequest: type: object description: > Request body for updating an entity. All fields are optional — only fields included in the request are updated. Fields not included are left unchanged. **Note**: When updating `additional_attributes.company_attributes`, the provided object replaces the existing company attributes in full. Include all attribute fields you want to retain. properties: name: type: string description: Updated entity name. example: NewsCatcher Inc. description: type: string description: Updated description. example: Updated description external_entity_id: type: string maxLength: 255 description: Updated external identifier for this entity. example: crm-12345 additional_attributes: $ref: '#/components/schemas/AdditionalAttributes' AdditionalAttributes: type: object description: Additional attributes for the entity, keyed by entity type. properties: company_attributes: $ref: '#/components/schemas/CompanyAttributes' EntityResponse: type: object required: - id - entity_type - organization_id - name - status properties: id: type: string format: uuid description: Unique identifier of the entity. example: 854198fa-f702-49db-a381-0427fa87f173 entity_type: $ref: '#/components/schemas/EntityType' organization_id: type: string format: uuid description: Organization that owns this entity. example: e5d9e9b0-e415-4941-8ef0-916c5ee56207 name: type: string description: Entity name. example: NewsCatcher description: type: - string - 'null' description: Free-text description. example: >- NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries). external_entity_id: type: - string - 'null' description: External identifier for this entity. Null when not set. example: crm-12345 additional_attributes: $ref: '#/components/schemas/AdditionalAttributes' status: $ref: '#/components/schemas/EntityStatus' created_by_user_id: type: string format: uuid description: ID of the user who created this entity. example: 870e258e-12ec-4a47-8656-e7a43b0265b3 created_at: type: string format: date-time description: > ISO 8601 timestamp of when the entity was created. Returned without timezone offset (server-local time). example: '2026-04-08T15:21:17.272139' updated_at: type: string format: date-time description: > ISO 8601 timestamp of when the entity was last updated. Returned without timezone offset (server-local time). example: '2026-04-08T15:21:18.248316' EntityValidationErrorBody: type: object required: - message - status - status_code description: | Error body returned by entity endpoints for field-level validation failures. Uses a different structure from the standard `Error` schema (`{"detail": "..."}`) used elsewhere in the API. properties: message: type: string description: | Human-readable description of all validation errors, including field path, failure message, and error type. example: >- Validation Error with the following fields: [{'field': 'body.entity_type', 'message': "entity_type must be one of ('company', 'person')", 'type': 'value_error'}] status: type: string description: HTTP status text. example: Bad Request status_code: type: integer description: HTTP status code. example: 400 Error: type: object properties: detail: type: string description: Error message. example: Invalid API key CompanyAttributes: type: object description: > Identifying attributes for a company entity. All fields are optional but improve matching quality. properties: domain: type: - string - 'null' description: | Company website domain without protocol or trailing slash. The most reliable identifier — strongly recommended when available. example: newscatcherapi.com key_persons: type: - array - 'null' items: type: string description: > Names of key people associated with the company (founders, executives, etc.). Improves matching for articles that mention people rather than the company name. example: - Artem Bugara - Maksym Sugonyaka alternative_names: type: - array - 'null' items: type: string description: > Alternative names, abbreviations, or aliases. Helps resolve common variations of the company name. example: - NewsCatcher CatchAll - NewsCatcher API EntityType: type: string enum: - company - person description: | The type of entity. - `company`: A company or organization (default). - `person`: An individual person. default: company EntityStatus: type: string enum: - pending - enriching - ready - failed description: > Processing status of an entity. - `pending`: Entity has been created and is queued for enrichment. - `enriching`: Enrichment is in progress. - `ready`: Enrichment complete — entity is indexed and ready for use in jobs. - `failed`: Enrichment failed. The entity may still be used but matching quality may be reduced. responses: EntityResponse: description: Full entity object with all attributes and metadata. content: application/json: schema: $ref: '#/components/schemas/EntityResponse' example: id: 854198fa-f702-49db-a381-0427fa87f173 entity_type: company organization_id: e5d9e9b0-e415-4941-8ef0-916c5ee56207 name: NewsCatcher description: >- NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries). external_entity_id: crm-12345 additional_attributes: company_attributes: domain: newscatcherapi.com key_persons: - Artem Bugara - Maksym Sugonyaka alternative_names: - NewsCatcher CatchAll - NewsCatcher API status: ready created_by_user_id: 870e258e-12ec-4a47-8656-e7a43b0265b3 created_at: '2026-04-08T15:21:17.272139' updated_at: '2026-04-08T15:21:18.248316' EntityBadRequestError: description: | Validation error in entity field values. Returned when required fields are missing or field values are invalid (for example, an unrecognised `entity_type` value). The response body uses a `message`/`status`/`status_code` structure, distinct from the standard `detail`-based error format used elsewhere in the API. content: application/json: schema: $ref: '#/components/schemas/EntityValidationErrorBody' examples: missing_name: summary: Required field missing value: message: >- Validation Error with the following fields: [{'field': 'body.name', 'message': 'field required', 'type': 'value_error.missing'}] status: Bad Request status_code: 400 invalid_entity_type: summary: Invalid enum value value: message: >- Validation Error with the following fields: [{'field': 'body.entity_type', 'message': "entity_type must be one of ('company', 'person')", 'type': 'value_error'}] status: Bad Request status_code: 400 ForbiddenError: description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/Error' NotFoundError: description: Job/monitor not found or results not available content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API key for authentication. ````