Save System Template Settings

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"SystemTemplateSettings\": {\n    \"CustomerNewCustomerTemplateId\": 123,\n    \"CustomerCustomerReplyTemplateId\": 123,\n    \"CustomerPasswordTemplateId\": 123,\n    \"CustomerConfirmEmailTemplateId\": 123,\n    \"CustomerChatLogTemplateId\": 123,\n    \"NewLinkTemplateId\": 123,\n    \"HotlistNewMessageTemplateId\": 123,\n    \"HotlistTicketActivatedTemplateId\": 123,\n    \"UserTicketAlarmTemplateId\": 123,\n    \"HotlistTicketTakenOverTemplateId\": 123,\n    \"UserActiveTicketsTemplateId\": 123,\n    \"UserNewMessageTemplateId\": 123,\n    \"UserTicketActivatedTemplateId\": 123,\n    \"UserNewTicketTemplateId\": 123,\n    \"PublishKbQuestionTemplateId\": 123,\n    \"PublishKbAnswerTemplateId\": 123,\n    \"UserTicketTakenOverTemplateId\": 123,\n    \"PrintTicketTemplateId\": 123,\n    \"WeekStatTemplateId\": 123,\n    \"TicketAlarmHotlistTemplateId\": 123,\n    \"EmailAddresses\": \"<string>\",\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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    SystemTemplateSettings: {
      CustomerNewCustomerTemplateId: 123,
      CustomerCustomerReplyTemplateId: 123,
      CustomerPasswordTemplateId: 123,
      CustomerConfirmEmailTemplateId: 123,
      CustomerChatLogTemplateId: 123,
      NewLinkTemplateId: 123,
      HotlistNewMessageTemplateId: 123,
      HotlistTicketActivatedTemplateId: 123,
      UserTicketAlarmTemplateId: 123,
      HotlistTicketTakenOverTemplateId: 123,
      UserActiveTicketsTemplateId: 123,
      UserNewMessageTemplateId: 123,
      UserTicketActivatedTemplateId: 123,
      UserNewTicketTemplateId: 123,
      PublishKbQuestionTemplateId: 123,
      PublishKbAnswerTemplateId: 123,
      UserTicketTakenOverTemplateId: 123,
      PrintTicketTemplateId: 123,
      WeekStatTemplateId: 123,
      TicketAlarmHotlistTemplateId: 123,
      EmailAddresses: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings",
  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([
    'SystemTemplateSettings' => [
        'CustomerNewCustomerTemplateId' => 123,
        'CustomerCustomerReplyTemplateId' => 123,
        'CustomerPasswordTemplateId' => 123,
        'CustomerConfirmEmailTemplateId' => 123,
        'CustomerChatLogTemplateId' => 123,
        'NewLinkTemplateId' => 123,
        'HotlistNewMessageTemplateId' => 123,
        'HotlistTicketActivatedTemplateId' => 123,
        'UserTicketAlarmTemplateId' => 123,
        'HotlistTicketTakenOverTemplateId' => 123,
        'UserActiveTicketsTemplateId' => 123,
        'UserNewMessageTemplateId' => 123,
        'UserTicketActivatedTemplateId' => 123,
        'UserNewTicketTemplateId' => 123,
        'PublishKbQuestionTemplateId' => 123,
        'PublishKbAnswerTemplateId' => 123,
        'UserTicketTakenOverTemplateId' => 123,
        'PrintTicketTemplateId' => 123,
        'WeekStatTemplateId' => 123,
        'TicketAlarmHotlistTemplateId' => 123,
        'EmailAddresses' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings"

payload = { "SystemTemplateSettings": {
        "CustomerNewCustomerTemplateId": 123,
        "CustomerCustomerReplyTemplateId": 123,
        "CustomerPasswordTemplateId": 123,
        "CustomerConfirmEmailTemplateId": 123,
        "CustomerChatLogTemplateId": 123,
        "NewLinkTemplateId": 123,
        "HotlistNewMessageTemplateId": 123,
        "HotlistTicketActivatedTemplateId": 123,
        "UserTicketAlarmTemplateId": 123,
        "HotlistTicketTakenOverTemplateId": 123,
        "UserActiveTicketsTemplateId": 123,
        "UserNewMessageTemplateId": 123,
        "UserTicketActivatedTemplateId": 123,
        "UserNewTicketTemplateId": 123,
        "PublishKbQuestionTemplateId": 123,
        "PublishKbAnswerTemplateId": 123,
        "UserTicketTakenOverTemplateId": 123,
        "PrintTicketTemplateId": 123,
        "WeekStatTemplateId": 123,
        "TicketAlarmHotlistTemplateId": 123,
        "EmailAddresses": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    SystemTemplateSettings: {
      CustomerNewCustomerTemplateId: 123,
      CustomerCustomerReplyTemplateId: 123,
      CustomerPasswordTemplateId: 123,
      CustomerConfirmEmailTemplateId: 123,
      CustomerChatLogTemplateId: 123,
      NewLinkTemplateId: 123,
      HotlistNewMessageTemplateId: 123,
      HotlistTicketActivatedTemplateId: 123,
      UserTicketAlarmTemplateId: 123,
      HotlistTicketTakenOverTemplateId: 123,
      UserActiveTicketsTemplateId: 123,
      UserNewMessageTemplateId: 123,
      UserTicketActivatedTemplateId: 123,
      UserNewTicketTemplateId: 123,
      PublishKbQuestionTemplateId: 123,
      PublishKbAnswerTemplateId: 123,
      UserTicketTakenOverTemplateId: 123,
      PrintTicketTemplateId: 123,
      WeekStatTemplateId: 123,
      TicketAlarmHotlistTemplateId: 123,
      EmailAddresses: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CustomerNewCustomerTemplateId": 123,
  "CustomerCustomerReplyTemplateId": 123,
  "CustomerPasswordTemplateId": 123,
  "CustomerConfirmEmailTemplateId": 123,
  "CustomerChatLogTemplateId": 123,
  "NewLinkTemplateId": 123,
  "HotlistNewMessageTemplateId": 123,
  "HotlistTicketActivatedTemplateId": 123,
  "UserTicketAlarmTemplateId": 123,
  "HotlistTicketTakenOverTemplateId": 123,
  "UserActiveTicketsTemplateId": 123,
  "UserNewMessageTemplateId": 123,
  "UserTicketActivatedTemplateId": 123,
  "UserNewTicketTemplateId": 123,
  "PublishKbQuestionTemplateId": 123,
  "PublishKbAnswerTemplateId": 123,
  "UserTicketTakenOverTemplateId": 123,
  "PrintTicketTemplateId": 123,
  "WeekStatTemplateId": 123,
  "TicketAlarmHotlistTemplateId": 123,
  "EmailAddresses": "<string>",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Save System Template Settings

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"SystemTemplateSettings\": {\n    \"CustomerNewCustomerTemplateId\": 123,\n    \"CustomerCustomerReplyTemplateId\": 123,\n    \"CustomerPasswordTemplateId\": 123,\n    \"CustomerConfirmEmailTemplateId\": 123,\n    \"CustomerChatLogTemplateId\": 123,\n    \"NewLinkTemplateId\": 123,\n    \"HotlistNewMessageTemplateId\": 123,\n    \"HotlistTicketActivatedTemplateId\": 123,\n    \"UserTicketAlarmTemplateId\": 123,\n    \"HotlistTicketTakenOverTemplateId\": 123,\n    \"UserActiveTicketsTemplateId\": 123,\n    \"UserNewMessageTemplateId\": 123,\n    \"UserTicketActivatedTemplateId\": 123,\n    \"UserNewTicketTemplateId\": 123,\n    \"PublishKbQuestionTemplateId\": 123,\n    \"PublishKbAnswerTemplateId\": 123,\n    \"UserTicketTakenOverTemplateId\": 123,\n    \"PrintTicketTemplateId\": 123,\n    \"WeekStatTemplateId\": 123,\n    \"TicketAlarmHotlistTemplateId\": 123,\n    \"EmailAddresses\": \"<string>\",\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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    SystemTemplateSettings: {
      CustomerNewCustomerTemplateId: 123,
      CustomerCustomerReplyTemplateId: 123,
      CustomerPasswordTemplateId: 123,
      CustomerConfirmEmailTemplateId: 123,
      CustomerChatLogTemplateId: 123,
      NewLinkTemplateId: 123,
      HotlistNewMessageTemplateId: 123,
      HotlistTicketActivatedTemplateId: 123,
      UserTicketAlarmTemplateId: 123,
      HotlistTicketTakenOverTemplateId: 123,
      UserActiveTicketsTemplateId: 123,
      UserNewMessageTemplateId: 123,
      UserTicketActivatedTemplateId: 123,
      UserNewTicketTemplateId: 123,
      PublishKbQuestionTemplateId: 123,
      PublishKbAnswerTemplateId: 123,
      UserTicketTakenOverTemplateId: 123,
      PrintTicketTemplateId: 123,
      WeekStatTemplateId: 123,
      TicketAlarmHotlistTemplateId: 123,
      EmailAddresses: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings",
  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([
    'SystemTemplateSettings' => [
        'CustomerNewCustomerTemplateId' => 123,
        'CustomerCustomerReplyTemplateId' => 123,
        'CustomerPasswordTemplateId' => 123,
        'CustomerConfirmEmailTemplateId' => 123,
        'CustomerChatLogTemplateId' => 123,
        'NewLinkTemplateId' => 123,
        'HotlistNewMessageTemplateId' => 123,
        'HotlistTicketActivatedTemplateId' => 123,
        'UserTicketAlarmTemplateId' => 123,
        'HotlistTicketTakenOverTemplateId' => 123,
        'UserActiveTicketsTemplateId' => 123,
        'UserNewMessageTemplateId' => 123,
        'UserTicketActivatedTemplateId' => 123,
        'UserNewTicketTemplateId' => 123,
        'PublishKbQuestionTemplateId' => 123,
        'PublishKbAnswerTemplateId' => 123,
        'UserTicketTakenOverTemplateId' => 123,
        'PrintTicketTemplateId' => 123,
        'WeekStatTemplateId' => 123,
        'TicketAlarmHotlistTemplateId' => 123,
        'EmailAddresses' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings"

payload = { "SystemTemplateSettings": {
        "CustomerNewCustomerTemplateId": 123,
        "CustomerCustomerReplyTemplateId": 123,
        "CustomerPasswordTemplateId": 123,
        "CustomerConfirmEmailTemplateId": 123,
        "CustomerChatLogTemplateId": 123,
        "NewLinkTemplateId": 123,
        "HotlistNewMessageTemplateId": 123,
        "HotlistTicketActivatedTemplateId": 123,
        "UserTicketAlarmTemplateId": 123,
        "HotlistTicketTakenOverTemplateId": 123,
        "UserActiveTicketsTemplateId": 123,
        "UserNewMessageTemplateId": 123,
        "UserTicketActivatedTemplateId": 123,
        "UserNewTicketTemplateId": 123,
        "PublishKbQuestionTemplateId": 123,
        "PublishKbAnswerTemplateId": 123,
        "UserTicketTakenOverTemplateId": 123,
        "PrintTicketTemplateId": 123,
        "WeekStatTemplateId": 123,
        "TicketAlarmHotlistTemplateId": 123,
        "EmailAddresses": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    SystemTemplateSettings: {
      CustomerNewCustomerTemplateId: 123,
      CustomerCustomerReplyTemplateId: 123,
      CustomerPasswordTemplateId: 123,
      CustomerConfirmEmailTemplateId: 123,
      CustomerChatLogTemplateId: 123,
      NewLinkTemplateId: 123,
      HotlistNewMessageTemplateId: 123,
      HotlistTicketActivatedTemplateId: 123,
      UserTicketAlarmTemplateId: 123,
      HotlistTicketTakenOverTemplateId: 123,
      UserActiveTicketsTemplateId: 123,
      UserNewMessageTemplateId: 123,
      UserTicketActivatedTemplateId: 123,
      UserNewTicketTemplateId: 123,
      PublishKbQuestionTemplateId: 123,
      PublishKbAnswerTemplateId: 123,
      UserTicketTakenOverTemplateId: 123,
      PrintTicketTemplateId: 123,
      WeekStatTemplateId: 123,
      TicketAlarmHotlistTemplateId: 123,
      EmailAddresses: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CustomerService/SaveSystemTemplateSettings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CustomerNewCustomerTemplateId": 123,
  "CustomerCustomerReplyTemplateId": 123,
  "CustomerPasswordTemplateId": 123,
  "CustomerConfirmEmailTemplateId": 123,
  "CustomerChatLogTemplateId": 123,
  "NewLinkTemplateId": 123,
  "HotlistNewMessageTemplateId": 123,
  "HotlistTicketActivatedTemplateId": 123,
  "UserTicketAlarmTemplateId": 123,
  "HotlistTicketTakenOverTemplateId": 123,
  "UserActiveTicketsTemplateId": 123,
  "UserNewMessageTemplateId": 123,
  "UserTicketActivatedTemplateId": 123,
  "UserNewTicketTemplateId": 123,
  "PublishKbQuestionTemplateId": 123,
  "PublishKbAnswerTemplateId": 123,
  "UserTicketTakenOverTemplateId": 123,
  "PrintTicketTemplateId": 123,
  "WeekStatTemplateId": 123,
  "TicketAlarmHotlistTemplateId": 123,
  "EmailAddresses": "<string>",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

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

SystemTemplateSettings

SaveSystemTemplateSettings: Saves and validates updated system templates. Throws exception if validation fails

SystemTemplateSettings

object

System template settings item Carrier object for SystemTemplateSettings. Services for the SystemTemplateSettings Carrier is available from the CustomerService Agent.

Show child attributes

Response

System template settings item Carrier object for SystemTemplateSettings. Services for the SystemTemplateSettings Carrier is available from the CustomerService Agent.

CustomerNewCustomerTemplateId

integer<int32>

Template for new contacts

CustomerCustomerReplyTemplateId

integer<int32>

Template for auto-reply

CustomerPasswordTemplateId

integer<int32>

Template for sending password to contacts

CustomerConfirmEmailTemplateId

integer<int32>

Template for sending confirmation e-mail to contacts

CustomerChatLogTemplateId

integer<int32>

Template for customer chat log

NewLinkTemplateId

integer<int32>

Template for new link

HotlistNewMessageTemplateId

integer<int32>

Template for notification of a new message in the favourites list

HotlistTicketActivatedTemplateId

integer<int32>

Template for notification of a activated ticket in the favourites list

UserTicketAlarmTemplateId

integer<int32>

Template for notification of escalated request

HotlistTicketTakenOverTemplateId

integer<int32>

Template for notification of reassignment of a request in the favourites list

UserActiveTicketsTemplateId

integer<int32>

Template for notification of open requests

UserNewMessageTemplateId

integer<int32>

Template for notification of new message

UserTicketActivatedTemplateId

integer<int32>

Template for notification of activated request

UserNewTicketTemplateId

integer<int32>

Template for new ticket notification

PublishKbQuestionTemplateId

integer<int32>

Template for formatting FAQ questions

PublishKbAnswerTemplateId

integer<int32>

Template for formatting FAQ answers

UserTicketTakenOverTemplateId

integer<int32>

Template for ticket reassignment

PrintTicketTemplateId

integer<int32>

Template for printing a ticket

WeekStatTemplateId

integer<int32>

Template for weekly statistics

TicketAlarmHotlistTemplateId

integer<int32>

Template for notification of an escalated request in the favourites list

EmailAddresses

string

One or more e-mail addresses (comma-separated)

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes