Set Preferences
using RestSharp;
var options = new RestClientOptions("http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Preferences\": {\n \"SearchCompany\": true,\n \"SearchFirstname\": true,\n \"SearchLastname\": true,\n \"SearchDepartment\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: {
SearchCompany: true,
SearchFirstname: true,
SearchLastname: true,
SearchDepartment: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "49843",
CURLOPT_URL => "http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Preferences' => [
'SearchCompany' => true,
'SearchFirstname' => true,
'SearchLastname' => true,
'SearchDepartment' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences"
payload = { "Preferences": {
"SearchCompany": True,
"SearchFirstname": True,
"SearchLastname": True,
"SearchDepartment": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: {
SearchCompany: true,
SearchFirstname: true,
SearchLastname: true,
SearchDepartment: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Setting Phone List Preferences to the CRM 5 user preferences
NsApiSlow threshold: 1000 ms.
Set Preferences
using RestSharp;
var options = new RestClientOptions("http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Preferences\": {\n \"SearchCompany\": true,\n \"SearchFirstname\": true,\n \"SearchLastname\": true,\n \"SearchDepartment\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: {
SearchCompany: true,
SearchFirstname: true,
SearchLastname: true,
SearchDepartment: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "49843",
CURLOPT_URL => "http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Preferences' => [
'SearchCompany' => true,
'SearchFirstname' => true,
'SearchLastname' => true,
'SearchDepartment' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences"
payload = { "Preferences": {
"SearchCompany": True,
"SearchFirstname": True,
"SearchLastname": True,
"SearchDepartment": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: {
SearchCompany: true,
SearchFirstname: true,
SearchLastname: true,
SearchDepartment: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/PhoneList/SetPreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
Preferences
SetPreferences: Setting Phone List Preferences to the CRM 5 user preferences
Search preferences for a phone list search Carrier object for PhoneListPreferences. Services for the PhoneListPreferences Carrier is available from the PhoneList Agent.
Show child attributes
Show child attributes
Response
204
No Content