Fields

Site Setting objects have the following fields and links:

Fields

field name description
agent_inactivity_timeout_full Amount of inactivity for flex agents, before the agent session is suspended.
agent_inactivity_timeout_flex Amount of inactivity for full time agents, before the agent session is suspended.
agent_name_descriptor Agent Descriptor; returns a string.
allow_screenpop_ignore_enabled Whether to allow agents to continue working while the screenpop is displayed.
auto_assign_case_on_open_enabled Whether to automatically assign the case to the Agent who opened it.
case_routing_method Provides status of case routing, returns one of the following: enabled, disabled or by_case_filter.
company_name Company name specified in site settings.
email_address_books_agent_enabled Allow autocomplete for agent email addresses in the TO, CC, BCC fields of a case reply. Returns true or false.
email_address_books_customer_enabled Allow autocomplete for customer email addresses in the TO, CC, BCC fields of a case reply. Returns true or false.
email_address_books_user_input_enabled Allow autocomplete for added email addresses in the TO, CC, BCC fields of a case reply. Returns true or false.
enable_feedback Customer feedback; can be true or false.
multi_lang_enabled Whether Multilingual Support is enabled; can be true or false.
multi_brand_enabled Allows you to use multiple Support Centers on a single Desk.com account.
open_cti_enabled Phone Integrations status; can be true or false.
portal_authentication_type The method of authentication customers use to access your portal. Returns "1" for No Authentication, "2" for Desk.com or "3" for Multipass.
portal_require_authentication_type Require authentication for a particular interaction: returns "1" for No authentication for anything, "2" for Interactions, or "3" for everything.
queue_screenpop_timeout The amount of time, in seconds, the case routing screen popup appears for the Agent.
queue_service_level_warn Service level warning threshold percentage.
route_one_case_enabled Route one case at a time; can be true or false.
set_status_pending_on_open_enabled Automatically change the case status to Pending, after the specified action. Return values can be: save_to_pending_on_reply_save, change_to_pending_on_case_open or no_status_changes.
timezone Timezone setting for the site. Returns string, e.g., "Eastern Time (US & Canada)".
undo_send_enabled Whether to allow agents to recall a sent Email, Twitter, or Facebook interaction within 10 seconds.

Links

rel class embeddable? description
self site_setting no this site setting

List

Retrieve a paginated list of site settings.

GET https://yoursite.desk.com/api/v2/site_settings

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/site_settings \
    -u email:password \
    -H 'Accept: application/json'

Example Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
{
  "total_entries": 13,
  "page": 1,
  "_links": {
    "self": {
      "href": "/api/v2/site_settings?page=1&per_page=50",
      "class": "page"
    },
    "first": {
      "href": "/api/v2/site_settings?page=1&per_page=50",
      "class": "page"
    },
    "last": {
      "href": "/api/v2/site_settings?page=1&per_page=50",
      "class": "page"
    },
    "previous": null,
    "next": null
  },
  "_embedded": {
    "entries": [
      {
        "name": "company_name",
        "value": "Cool Surfboard Co.",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/1",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "timezone",
        "value": "Pacific Time (US & Canada)",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/2",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "queue_screenpop_timeout",
        "value": 30,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/2400",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "queue_service_level_warn",
        "value": 75,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/2450",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "auto_assign_case_on_open_enabled",
        "value": "auto_assign_case_on_open",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/2500",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "set_status_pending_on_open_enabled",
        "value": "change_to_pending_on_case_open",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/2550",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "portal_authentication_type",
        "value": "1",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/3260",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "portal_require_authentication_type",
        "value": "1",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/3264",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "agent_name_descriptor",
        "value": "Agent",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/5000",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "case_routing_method",
        "value": "disabled",
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/6000",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "allow_screenpop_ignore_enabled",
        "value": true,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/7000",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "route_one_case_enabled",
        "value": false,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/8000",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "agent_inactivity_timeout_full",
        "value": 60,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/14000",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "agent_inactivity_timeout_flex",
        "value": 60,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/14100",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "undo_send_enabled",
        "value": true,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/27250",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "multi_lang_enabled",
        "value": true,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/27400",
            "class": "site_setting"
          }
        }
      },
      {
        "name": "multi_brand_enabled",
        "value": false,
        "_links": {
          "self": {
            "href": "/api/v2/site_settings/27500",
            "class": "site_setting"
          }
        }
      }
    ]
  }
}

Show

Retrieve a single site setting.

GET https://yoursite.desk.com/api/v2/site_settings/:id

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/site_settings/:id \
    -u email:password \
    -H 'Accept: application/json'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "name": "company_name",
  "value": "Cool Surfboard Co.",
  "_links": {
    "self": {
      "href": "/api/v2/site_settings/1",
      "class": "site_setting"
    }
  }
}

Language Fields

Language objects have the following fields and links:

Fields

field name description
id iso language code
name language name
agent whether or not the language is valid for Desk.com Agent localization
case whether or not the language is valid as case language
customer whether or not the language is valid as customer language
is_case_default whether or not the language is the default case language

Note: Multilingual support must be enabled in the Desk.com Admin for values other than false to be returned for case and customer fields.

Links

rel class embeddable? description
self language no this resource

List Languages

List all languages on this site.

GET https://yoursite.desk.com/api/v2/site/languages

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/site/languages \
    -u email:password \
    -H 'Accept: application/json'

Example Response

This response was shortened for clarity.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
  "total_entries": 2,
  "page": 1,
  "_links": {
    "self": {
      "href": "/api/v2/languages?page=1&per_page=50",
      "class": "page"
    },
    "first": {
      "href": "/api/v2/languages?page=1&per_page=50",
      "class": "page"
    },
    "last": {
      "href": "/api/v2/languages?page=1&per_page=50",
      "class": "page"
    },
    "next": null,
    "previous": null
  },
  "_embedded": {
    "entries": [
      {
        "id": "en_us",
        "name": "english_united_states",
        "agent": true,
        "case": true,
        "customer": true,
        "is_case_default": true,
        "_links": {
          "self": {
            "href": "/api/v2/site/languages/en_us",
            "class": "language"
          }
        }
      },
      {
        "id": "fr",
        "name": "french",
        "agent": false,
        "case": false,
        "customer": true,
        "is_case_default": true,
        "_links": {
          "self": {
            "href": "/api/v2/site/languages/fr",
            "class": "language"
          }
        }
      }
    ]
  }
}

Show Language

Retrieve a single language.

GET https://yoursite.desk.com/api/v2/site/languages/:id

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/site/languages/en_us \
    -u email:password \
    -H 'Accept: application/json'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "id": "en_us",
  "name": "english_united_states",
  "agent": true,
  "case": true,
  "customer": true,
  "is_case_default": true,
  "_links": {
    "self": {
      "href": "/api/v2/site/languages/en_us",
      "class": "language"
    }
  }
}