Skip to main content
PATCH
Update entity

Authorizations

x-api-key
string
header
required

API key for authentication.

Path Parameters

entity_id
string<uuid>
required

Unique entity identifier.

Body

application/json

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.

name
string

Updated entity name.

Example:

"NewsCatcher Inc."

description
string

Updated description.

Example:

"Updated description"

external_entity_id
string

Updated external identifier for this entity.

Maximum string length: 255
Example:

"crm-12345"

additional_attributes
object

Additional attributes for the entity, keyed by entity type.

Response

Full entity object with all attributes and metadata.

id
string<uuid>
required

Unique identifier of the entity.

Example:

"854198fa-f702-49db-a381-0427fa87f173"

entity_type
enum<string>
default:company
required

The type of entity.

  • company: A company or organization (default).
  • person: An individual person.
Available options:
company,
person
organization_id
string<uuid>
required

Organization that owns this entity.

Example:

"e5d9e9b0-e415-4941-8ef0-916c5ee56207"

name
string
required

Entity name.

Example:

"NewsCatcher"

status
enum<string>
required

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.
Available options:
pending,
enriching,
ready,
failed
description
string | null

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
string | null

External identifier for this entity. Null when not set.

Example:

"crm-12345"

additional_attributes
object

Additional attributes for the entity, keyed by entity type.

created_by_user_id
string<uuid>

ID of the user who created this entity.

Example:

"870e258e-12ec-4a47-8656-e7a43b0265b3"

created_at
string<date-time>

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
string<date-time>

ISO 8601 timestamp of when the entity was last updated. Returned without timezone offset (server-local time).

Example:

"2026-04-08T15:21:18.248316"