WEweb2wave

Change Support Desk settings

Changed on

Owner and Administrators only. Send only what you change. auto_replies is merged key by key with the current settings (so { "follow_up": { "days": 5 } } changes just that); off_hours.days is replaced as a whole.

Enabling needs a subscription, a grant or a running free trial (403 otherwise — see POST /support/billing/checkout). Changing custom_email to a new domain resets its verification and starts adding the domain to the mail provider; then add the returned DNS records and call POST /support/settings/check-dns. The email cannot be one that another enabled project uses.

patch/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

Headers

api_keystring required
X-Web2wave-Project-Idstring
Example:my-funnel

Required for client API keys (projects.project_id slug). Not needed for legacy project keys.

Request body

enabledboolean
setup_method'shared' | 'custom' | 'forwarding'
custom_emailstring email nullable

e.g. help@support.yourdomain.com; null removes it

signaturestring nullable
daily_summaryboolean

Example request

{
  "auto_replies": {
    "after_reply": {
      "off_hours": {
        "days": [
          1,
          2,
          3,
          4,
          5
        ],
        "from": "09:00",
        "to": "18:00"
      }
    }
  }
}

Response

Updated settings

successboolean

Example response

{
  "settings": {
    "inbox": {
      "primary": "my-funnel@gethelpwithapps.com",
      "inbound_domain": "gethelpwithapps.com"
    },
    "muted_emails_limit": 200,
    "auto_replies": {
      "after_reply": {
        "off_hours": {
          "days": [
            1,
            2,
            3,
            4,
            5
          ],
          "from": "09:00",
          "to": "18:00"
        }
      }
    },
    "timezone": "UTC",
    "billing": {
      "status": "active",
      "amount_usd": 99,
      "trial": {
        "days": 14
      }
    }
  }
}

Changes