> ## Documentation Index > Fetch the complete documentation index at: https://docs.hiveinspect.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a contact **The Hive Inspect API is a work in progress.** It is available to a small group of accounts today, and the release for everyone is coming very soon. ## OpenAPI ````yaml /api/openapi.json patch /v1/contacts/{contactId} openapi: 3.1.0 info: title: Hive Inspect API version: 1.0.0 description: Connect other tools to your Hive Inspect contacts, inspections and events. servers: - url: https://api.hiveinspect.com security: - bearerAuth: [] tags: - name: Contacts description: Agents, clients and every other contact in your organization. - name: Agencies description: The brokerages your agents belong to. Read-only. - name: Inspections description: Read-only access to your inspections. - name: Attachments description: Additional reports and additional documents on an inspection. - name: Events description: Extra appointments on an inspection, such as a radon drop-off or pick-up. paths: /v1/contacts/{contactId}: patch: tags: - Contacts summary: Update a contact operationId: updateContact parameters: - name: contactId in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ContactUpdate' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Contact' '400': description: Invalid parameter '401': description: Missing, invalid or inactive API key '404': description: Not found '409': description: Email already used by another contact '422': description: Validation error '429': description: Rate limit exceeded (120 requests/minute per key owner) components: schemas: ContactUpdate: type: object additionalProperties: false properties: first_name: type: string last_name: type: - string - 'null' email: type: string format: email cc_email: type: - string - 'null' format: email phone: type: - string - 'null' business_name: type: - string - 'null' agency_name: type: - string - 'null' description: >- Agency name. A name that matches one of your agencies links the contact to it; any other name is kept as plain text. Prefer agency_id. address: type: - string - 'null' address_line2: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' zip: type: - string - 'null' country: type: - string - 'null' description: ISO-2, e.g. US or CA birthday: type: - string - 'null' format: date website: type: - string - 'null' social: type: - object - 'null' additionalProperties: type: string notes: type: - string - 'null' agency_id: type: - string - 'null' format: uuid description: >- Link the contact to an agency from /v1/agencies. Takes precedence over agency_name. Send null to unlink. uses_agency_address: type: - boolean - 'null' description: >- true: use the agency's address for this contact. false: keep the contact's own address. tag_ids: type: - array - 'null' items: type: string format: uuid description: >- Replace the contact's tags with these tag ids (see /v1/tags). An empty list removes every tag. Send tag_ids or tags, not both. tags: type: - array - 'null' items: type: string description: >- Replace the contact's tags with these tag names (case-insensitive). The tags must already exist. description: Only the fields sent are changed; null clears an optional field. example: phone: (512) 555-0199 notes: null Contact: type: object properties: id: type: string format: uuid first_name: type: string last_name: type: - string - 'null' email: type: string format: email cc_email: type: - string - 'null' format: email phone: type: - string - 'null' business_name: type: - string - 'null' agency_name: type: - string - 'null' address: type: - string - 'null' address_line2: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' zip: type: - string - 'null' country: type: - string - 'null' description: ISO-2, e.g. US or CA birthday: type: - string - 'null' format: date website: type: - string - 'null' social: type: - object - 'null' additionalProperties: type: string notes: type: - string - 'null' tags: type: array items: type: object properties: id: type: string name: type: string roles: type: array items: type: string description: Distinct roles this contact has had on inspections created_at: type: string format: date-time updated_at: type: string format: date-time photo_url: type: - string - 'null' description: Signed link, valid for 1 hour agency_id: type: - string - 'null' format: uuid description: >- The agency (brokerage) this contact is linked to, from /v1/agencies. Null when agency_name is plain text. uses_agency_address: type: boolean description: 'true: the contact''s address follows the agency''s address' agency: oneOf: - type: object properties: id: type: string format: uuid name: type: - string - 'null' phone: type: - string - 'null' website: type: - string - 'null' - type: 'null' description: The linked agency, when there is one example: id: 0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f first_name: Dana last_name: Reyes email: dana@example.com cc_email: null phone: (512) 555-0142 business_name: null agency_name: Lone Star Realty agency_id: 6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c agency: id: 6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c name: Lone Star Realty phone: (512) 555-0100 website: https://lonestarrealty.example.com uses_agency_address: true address: 410 Oak St address_line2: null city: Austin state: TX zip: '78701' country: US birthday: '1988-04-12' website: null social: null notes: Prefers text messages photo_url: https://files.example.com/signed-link-valid-for-1-hour tags: - id: 5a1d9c3e-2b7f-4f0a-8c6d-1e2f3a4b5c6d name: Top agent roles: - Buyer Agent - Listing Agent created_at: '2026-03-02T15:04:11Z' updated_at: '2026-09-18T20:41:07Z' securitySchemes: bearerAuth: type: http scheme: bearer description: Your API key from Business Tools → API Access. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.