update_entity
Update an entity's name, description, external_entity_id, and/or attributes. Provide the entity ID and optional new values for fields to change.
Instructions
Update an entity's name, description, external_entity_id, and/or attributes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Optional new entity name. | |
| api_key | No | CatchAll API key. Optional if provided via x-api-key header or CATCHALL_API_KEY env var. | |
| entity_id | Yes | The entity ID to update. | |
| description | No | Optional new description. | |
| external_entity_id | No | Optional customer-supplied identifier linking this entity to an external system's record (new in 1.6.3). | |
| additional_attributes | No | Optional updated structured attributes (see `create_entity` for the company_attributes shape). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |