> ## Documentation Index > Fetch the complete documentation index at: https://docs.vorel.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update a conversation > Strict-partial update. Mutable surface is `customer_name` + `customer_language` only — `channel` / `customer_identifier` form the unique-message-routing tuple and are NOT updatable; `status` is NOT updatable here either (transitions like `'closed'` have heavy side-effects — billing event creation, QA scoring, `conversation.closed` webhook — and need a dedicated future endpoint). No webhook event is emitted today (the `conversation.*` event family is lifecycle-specific; there is no generic `conversation.updated`). ## OpenAPI ````yaml https://app.vorel.ai/api/v1/openapi.json patch /api/v1/conversations/{id} openapi: 3.1.0 info: title: Vorel API version: 0.1.0 description: >- Public API for Vorel — the AI receptionist for any business. Read your conversations, leads, appointments, and catalog; push CRM-side updates back into the platform. All endpoints accept bearer-auth API keys issued at `/settings/integrations/api-keys` in the dashboard. Per-key rate limit is 200 req/min. contact: name: Vorel support email: hello@vorel.ai license: name: Proprietary servers: - url: https://app.vorel.ai description: Production - url: http://localhost:3000 description: Local dev security: - BearerAuth: [] tags: - name: Conversations description: Inbound customer conversations across channels. - name: Leads description: Qualified-lead rows attached to conversations. - name: Appointments description: Scheduled customer engagements. - name: Offerings description: Tenant catalog (properties, services, treatments — vertical-specific). - name: Analytics description: >- Aggregate metrics for tenant + automation consumers. The around-the-brain workflows read these rather than mass-querying the resource endpoints. - name: CRM description: >- Operator-side writes into the tenant's configured CRM (HubSpot / Salesforce / Zoho / etc.). Per-tenant field mappings translate canonical Vorel keys to vendor-side keys before the driver call. paths: /api/v1/conversations/{id}: patch: tags: - Conversations summary: Update a conversation description: >- Strict-partial update. Mutable surface is `customer_name` + `customer_language` only — `channel` / `customer_identifier` form the unique-message-routing tuple and are NOT updatable; `status` is NOT updatable here either (transitions like `'closed'` have heavy side-effects — billing event creation, QA scoring, `conversation.closed` webhook — and need a dedicated future endpoint). No webhook event is emitted today (the `conversation.*` event family is lifecycle-specific; there is no generic `conversation.updated`). operationId: updateConversation parameters: - name: id in: path required: true schema: type: string format: uuid description: UUID of the conversation to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConversationUpdate' responses: '200': description: Conversation updated. content: application/json: schema: $ref: '#/components/schemas/Conversation' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' security: - BearerAuth: - conversations:write components: schemas: ConversationUpdate: type: object description: >- Partial-update body for `PATCH /api/v1/conversations/{id}`. Must include at least one updatable field. Setting a nullable field to `null` clears it; omitted fields are left untouched. The mutable surface is `customer_name` + `customer_language` only — `channel` / `customer_identifier` form the unique-message-routing tuple and are NOT updatable; `status` is NOT updatable here either (transitions like `'closed'` have heavy side-effects — billing event creation, QA scoring, `conversation.closed` webhook — and need a dedicated future endpoint). No webhook event is emitted (the `conversation.*` event family is lifecycle-specific; there is no generic `conversation.updated`). properties: customer_name: type: string maxLength: 200 nullable: true customer_language: type: string pattern: ^[a-z]{2}(-[A-Z]{2})?$ nullable: true Conversation: type: object required: - id - channel - customer_identifier - status - created_at properties: id: type: string format: uuid channel: type: string description: Inbound channel slug — e.g. `whatsapp`, `voice`, `webform`. customer_identifier: type: string description: >- Channel-native identifier — phone for WhatsApp/voice (E.164), email for webform, etc. customer_name: type: string nullable: true customer_language: type: string nullable: true description: ISO 639-1 (`en`, `ar`, …) when known. status: type: string description: Conversation lifecycle state — `active`, `closed`, … first_message_at: type: string format: date-time nullable: true last_message_at: type: string format: date-time nullable: true created_at: type: string format: date-time ErrorEnvelope: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - rate_limited - bad_request - not_found - conflict - internal_error description: Machine-readable error category. message: type: string description: >- Human-readable error description; safe to surface in tenant logs. responses: BadRequest: description: Body validation failed. Error message names the offending field. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: Missing, malformed, unknown, or revoked API key. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: >- API key is valid but lacks the required scope for this endpoint. Issue a new key with the necessary scope at `/settings/integrations/api-keys`. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: >- A referenced resource (e.g. `conversation_id` on a lead create, or any of the optional FK targets on an appointment create) is not visible to your tenant. Cross-tenant rows return the same envelope as truly-non-existent rows — this is intentional to prevent enumeration. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' RateLimited: description: >- 200 req/min per API key exceeded. `Retry-After` header carries seconds-until-reset. headers: Retry-After: schema: type: integer X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer description: Unix epoch seconds. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: vapk__<48-hex> description: >- Tenant-issued API key. Format: `vapk_live_<48 hex chars>` (60 chars total). Issue + manage at `/settings/integrations/api-keys` in the Vorel dashboard. Each key has a scope set (`read`, `leads:write`, `appointments:write`, `offerings:write`); endpoints requiring a write scope reject keys without it with a 403 envelope. ````