---
title: "Support Desk settings"
method: GET
path: "/support/settings"
---

# Support Desk settings

`GET /support/settings`

## Request

- Base URL: `https://api.web2wave.com/api`
- URL: `https://api.web2wave.com/api/support/settings`
- Auth: API key in header `api_key`

The "Support Desk" tab of the project settings: the inbox address, custom domain and its DNS records, signature,
daily summary, muted senders, auto replies, and the subscription / trial state. Works before the desk is enabled.
`request_types` lists the types with their descriptions.

## Headers

- `api_key` string, required
- `X-Web2wave-Project-Id` string

## Response `200`

Settings

- object
  - `success` boolean
  - `settings` SupportSettings
    - `enabled` boolean
    - `has_access` boolean: False when the free trial is over and there is no subscription or grant
    - `setup_method` 'shared' | 'custom' | 'forwarding': How the team receives mail (informational; the three ways can be combined)
    - `inbox` object
      - `primary` string: Address customers write to. Use it as Reply-To of your emails, or forward your mailbox to it.
      - `inbound_domain` string
      - `custom_email` string, nullable
      - `all` string[]
    - `custom_domain` object, nullable: Present when `custom_email` is on a domain of your own.
      - `domain` string
      - `verified` boolean
      - `dns_records` object[]: DKIM and MX records to add at your DNS provider
    - `signature` string: Added under every reply. Placeholders: `{agent_name}`, `{agent_first_name}`, `{project_name}`
    - `signature_placeholders` object
    - `daily_summary` boolean: Digest of open requests at 10:00 UTC to Owner, Administrators and Support Managers
    - `muted_emails` string[]: Addresses and `*` patterns whose conversations are hidden everywhere
    - `muted_emails_limit` integer
    - `auto_replies` SupportAutoReplies: Automatic messages to customers. Every template id must be a template of this project (`GET /support/templates`); foreign ids are dropped. Switching `enabled` on creates the four starter templates for any slot left empty.
      - `enabled` boolean: Master switch
      - `enabled_at` string, date-time, nullable: Read-only. Follow-ups never touch conversations answered before this moment
      - `after_reply` object: First reply, sent when a customer starts a new conversation (a new customer, a closed conversation, or one quiet for 7 days). At most once per conversation every 7 days.
        - `enabled` boolean
        - `template_id` integer, nullable
        - `off_hours` object: A different message outside working hours (project time zone).
          - `enabled` boolean
          - `template_id` integer, nullable
          - `days` integer[]: Working days, 1 = Monday … 7 = Sunday. Replaced as a whole.
          - `from` string: Working day starts, HH:MM
          - `to` string: Working day ends, HH:MM
      - `by_type` object: Per request type (keys are `request_type` values): a template id to send that message instead, `"none"` to send nothing, or `null`/absent for the default message. `spam_auto` gets no reply unless you set a template.
      - `follow_up` object: Reminder for a conversation that waits for the customer (the last message is a reply by a person).
        - `enabled` boolean
        - `days` integer: Days of silence after our last reply
        - `template_id` integer, nullable
      - `close` object: Close a conversation that is still silent after the follow-up. Works only while `follow_up.enabled` is on.
        - `enabled` boolean
        - `days` integer: Days after the follow-up
        - `send_message` boolean
        - `template_id` integer, nullable
    - `template_placeholders` object
    - `timezone` string
    - `billing` SupportBilling
      - `subscribed` boolean
      - `status` string, nullable
      - `subscription_id` string, nullable
      - `amount_usd` number
      - `price_configured` boolean
      - `has_access` boolean
      - `trial` object
        - `state` 'not_started' | 'active' | 'expired', nullable: Null when a subscription or a grant covers the project. The trial starts with the first customer email.
        - `days` integer
        - `days_left` integer, nullable
        - `ends_at` string, date-time, nullable
      - `can_manage_billing` boolean: Only on `GET /support/billing`
  - `request_types` object[]
    - `value` string
    - `label` string
    - `description` string

## Changes

- **2026-11-03** `eb8b2d9124ac`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/web2wave/apis/web2wave-api/changes/support/settings/get.md)

---

[API](https://skmtc.dev/web2wave/apis/web2wave-api.md) - [All operations](https://skmtc.dev/web2wave/apis/web2wave-api/llms.txt) - [OpenAPI document](https://skmtc.dev/web2wave/apis/web2wave-api/revisions/eb8b2d9124ac?raw)