---
title: "Update Inbox"
method: PATCH
path: "/v1/workspaces/{workspace_id}/inboxes/{id}"
tags: ["Inboxes"]
---

# Update Inbox

`PATCH /v1/workspaces/{workspace_id}/inboxes/{id}`

## Request

- Base URL: `https://api.oxvo.com`
- URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/inboxes/{id}`
- Auth: API key in header `api_access_token`

Update an existing inbox

## Path parameters

- `workspace_id` integer, required
- `id` number, required

## Request body

- InboxUpdatePayload
  - `name` string: The name of the inbox
  - `avatar` string, binary: Image file for avatar
  - `greeting_enabled` boolean: Enable greeting message
  - `greeting_message` string: Greeting message to be displayed on the widget
  - `enable_email_collect` boolean: Enable email collection
  - `csat_survey_enabled` boolean: Enable CSAT survey
  - `enable_auto_assignment` boolean: Enable Auto Assignment
  - `working_hours_enabled` boolean: Enable working hours
  - `out_of_office_message` string: Out of office message to be displayed on the widget
  - `timezone` string: Timezone of the inbox
  - `allow_messages_after_resolved` boolean: Allow messages after conversation is resolved
  - `lock_to_single_conversation` boolean: Lock to single conversation
  - `portal_id` integer: Id of the help center portal to attach to the inbox
  - `sender_name_type` 'friendly' | 'professional': Sender name type for the inbox
  - `business_name` string: Business name for the inbox
  - `channel` object
    - `website_url` string: URL at which the widget will be loaded
    - `welcome_title` string: Welcome title to be displayed on the widget
    - `welcome_tagline` string: Welcome tagline to be displayed on the widget
    - `messenger_color` string: A Hex-color string used to customize the widget

## Response `200`

Success

- Inbox
  - `id` number: ID of the inbox
  - `name` string: The name of the inbox
  - `website_url` string: Website URL
  - `channel_type` string: The type of the inbox
  - `avatar_url` string: The avatar image of the inbox
  - `messenger_color` string: Widget Color used for customization of the widget
  - `website_token` string: Website Token
  - `enable_auto_assignment` boolean: The flag which shows whether Auto Assignment is enabled or not
  - `web_widget_script` string: Script used to load the website widget
  - `welcome_title` string, nullable: Welcome title to be displayed on the widget
  - `welcome_tagline` string, nullable: Welcome tagline to be displayed on the widget
  - `greeting_enabled` boolean: The flag which shows whether greeting is enabled
  - `greeting_message` string, nullable: A greeting message when the user starts the conversation
  - `channel_id` number: ID of the channel this inbox belongs to
  - `working_hours_enabled` boolean: The flag which shows whether working hours feature is enabled
  - `enable_email_collect` boolean: The flag to enable collecting email from contacts
  - `csat_survey_enabled` boolean: The flag to enable CSAT survey
  - `auto_assignment_config` object: Configuration settings for auto assignment
  - `out_of_office_message` string, nullable: Message to show when agents are out of office
  - `working_hours` object[]: Configuration for working hours of the inbox
    - `day_of_week` number: Day of the week (0-6, where 0 is Sunday)
    - `closed_all_day` boolean: Whether the inbox is closed for the entire day
    - `open_hour` number, nullable: Hour when inbox opens (0-23)
    - `open_minutes` number, nullable: Minutes of the hour when inbox opens (0-59)
    - `close_hour` number, nullable: Hour when inbox closes (0-23)
    - `close_minutes` number, nullable: Minutes of the hour when inbox closes (0-59)
    - `open_all_day` boolean: Whether the inbox is open for the entire day
  - `timezone` string: Timezone configuration for the inbox
  - `callback_webhook_url` string, nullable: Webhook URL for callbacks
  - `allow_messages_after_resolved` boolean: Whether to allow messages after a conversation is resolved
  - `lock_to_single_conversation` boolean: Whether to lock a contact to a single conversation
  - `sender_name_type` string: Type of sender name to display (e.g., friendly)
  - `business_name` string, nullable: Business name associated with the inbox
  - `hmac_mandatory` boolean: Whether HMAC verification is mandatory
  - `selected_feature_flags` string[], nullable: Selected feature flags for the inbox
  - `reply_time` string: Expected reply time
  - `messaging_service_sid` string, nullable: Messaging service SID for SMS providers
  - `phone_number` string, nullable: Phone number associated with the inbox
  - `medium` string: Medium of communication (e.g., sms, email)
  - `provider` string, nullable: Provider of the channel

## Other responses

- `403`: Access denied
- `404`: Inbox not found

---

[API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)