Support Desk settings

Changed on

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.

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

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.

Response

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