Perform Needed Category Update
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"PersonId\": 123,\n \"ContactId\": 123,\n \"CategoryId\": 123,\n \"Setting\": {\n \"Enabled\": true,\n \"UserConfirmation\": true,\n \"DefaultCategory\": 123,\n \"LeadstatusId\": 123,\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({
PersonId: 123,
ContactId: 123,
CategoryId: 123,
Setting: {
Enabled: true,
UserConfirmation: true,
DefaultCategory: 123,
LeadstatusId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate', 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 => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate",
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([
'PersonId' => 123,
'ContactId' => 123,
'CategoryId' => 123,
'Setting' => [
'Enabled' => true,
'UserConfirmation' => true,
'DefaultCategory' => 123,
'LeadstatusId' => 123,
'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:56350/api/v1/Agents/List/PerformNeededCategoryUpdate"
payload = {
"PersonId": 123,
"ContactId": 123,
"CategoryId": 123,
"Setting": {
"Enabled": True,
"UserConfirmation": True,
"DefaultCategory": 123,
"LeadstatusId": 123,
"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({
PersonId: 123,
ContactId: 123,
CategoryId: 123,
Setting: {
Enabled: true,
UserConfirmation: true,
DefaultCategory: 123,
LeadstatusId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Perform Needed Category Update
Does the actual update of the category.
Ask the user first, if user confirmed yes, do automatically update category, this call will do that actual update NsApiSlow threshold: 5000 ms.
Perform Needed Category Update
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"PersonId\": 123,\n \"ContactId\": 123,\n \"CategoryId\": 123,\n \"Setting\": {\n \"Enabled\": true,\n \"UserConfirmation\": true,\n \"DefaultCategory\": 123,\n \"LeadstatusId\": 123,\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({
PersonId: 123,
ContactId: 123,
CategoryId: 123,
Setting: {
Enabled: true,
UserConfirmation: true,
DefaultCategory: 123,
LeadstatusId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate', 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 => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate",
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([
'PersonId' => 123,
'ContactId' => 123,
'CategoryId' => 123,
'Setting' => [
'Enabled' => true,
'UserConfirmation' => true,
'DefaultCategory' => 123,
'LeadstatusId' => 123,
'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:56350/api/v1/Agents/List/PerformNeededCategoryUpdate"
payload = {
"PersonId": 123,
"ContactId": 123,
"CategoryId": 123,
"Setting": {
"Enabled": True,
"UserConfirmation": True,
"DefaultCategory": 123,
"LeadstatusId": 123,
"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({
PersonId: 123,
ContactId: 123,
CategoryId: 123,
Setting: {
Enabled: true,
UserConfirmation: true,
DefaultCategory: 123,
LeadstatusId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/PerformNeededCategoryUpdate', 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
PersonId, ContactId, CategoryId, Setting
PerformNeededCategoryUpdate: Does the actual update of the category. Ask the user first, if user confirmed yes, do automatically update category, this call will do that actual update
Response
204
No Content
⌘I