Save Form Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Marketing/SaveFormEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"FormId\": 123,\n  \"FormKey\": \"<string>\",\n  \"Name\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"Config\": \"<string>\",\n  \"FolderId\": 123,\n  \"ScriptId\": 123,\n  \"ResponseShipmentId\": 123,\n  \"Active\": true,\n  \"Expires\": \"2023-11-07T05:31:56Z\",\n  \"MaxSubmits\": 123,\n  \"Recipe\": \"<string>\",\n  \"GroupId\": 123,\n  \"NewTicket\": true,\n  \"Registered\": \"2023-11-07T05:31:56Z\",\n  \"RegisteredAssociateId\": 123,\n  \"Updated\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAssociateId\": 123,\n  \"UpdatedCount\": 123,\n  \"EmailFlows\": [\n    123\n  ],\n  \"FolderName\": \"<string>\",\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\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({
    FormId: 123,
    FormKey: '<string>',
    Name: '<string>',
    Description: '<string>',
    Config: '<string>',
    FolderId: 123,
    ScriptId: 123,
    ResponseShipmentId: 123,
    Active: true,
    Expires: '2023-11-07T05:31:56Z',
    MaxSubmits: 123,
    Recipe: '<string>',
    GroupId: 123,
    NewTicket: true,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    EmailFlows: [123],
    FolderName: '<string>',
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/Agents/Marketing/SaveFormEntity', 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/Marketing/SaveFormEntity",
  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([
    'FormId' => 123,
    'FormKey' => '<string>',
    'Name' => '<string>',
    'Description' => '<string>',
    'Config' => '<string>',
    'FolderId' => 123,
    'ScriptId' => 123,
    'ResponseShipmentId' => 123,
    'Active' => true,
    'Expires' => '2023-11-07T05:31:56Z',
    'MaxSubmits' => 123,
    'Recipe' => '<string>',
    'GroupId' => 123,
    'NewTicket' => true,
    'Registered' => '2023-11-07T05:31:56Z',
    'RegisteredAssociateId' => 123,
    'Updated' => '2023-11-07T05:31:56Z',
    'UpdatedAssociateId' => 123,
    'UpdatedCount' => 123,
    'EmailFlows' => [
        123
    ],
    'FolderName' => '<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/Marketing/SaveFormEntity"

payload = {
    "FormId": 123,
    "FormKey": "<string>",
    "Name": "<string>",
    "Description": "<string>",
    "Config": "<string>",
    "FolderId": 123,
    "ScriptId": 123,
    "ResponseShipmentId": 123,
    "Active": True,
    "Expires": "2023-11-07T05:31:56Z",
    "MaxSubmits": 123,
    "Recipe": "<string>",
    "GroupId": 123,
    "NewTicket": True,
    "Registered": "2023-11-07T05:31:56Z",
    "RegisteredAssociateId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "UpdatedAssociateId": 123,
    "UpdatedCount": 123,
    "EmailFlows": [123],
    "FolderName": "<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({
    FormId: 123,
    FormKey: '<string>',
    Name: '<string>',
    Description: '<string>',
    Config: '<string>',
    FolderId: 123,
    ScriptId: 123,
    ResponseShipmentId: 123,
    Active: true,
    Expires: '2023-11-07T05:31:56Z',
    MaxSubmits: 123,
    Recipe: '<string>',
    GroupId: 123,
    NewTicket: true,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    EmailFlows: [123],
    FolderName: '<string>',
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

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

{
  "FormId": 123,
  "FormKey": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "Config": "<string>",
  "FolderId": 123,
  "ScriptId": 123,
  "ResponseShipmentId": 123,
  "Active": true,
  "Expires": "2023-11-07T05:31:56Z",
  "MaxSubmits": 123,
  "Type": "Normal",
  "Recipe": "<string>",
  "GroupId": 123,
  "NewTicket": true,
  "RecaptchaMode": "NotAvailable",
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociateId": 123,
  "Updated": "2023-11-07T05:31:56Z",
  "UpdatedAssociateId": 123,
  "UpdatedCount": 123,
  "EmailFlows": [
    123
  ],
  "FolderName": "<string>",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Save Form Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Marketing/SaveFormEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"FormId\": 123,\n  \"FormKey\": \"<string>\",\n  \"Name\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"Config\": \"<string>\",\n  \"FolderId\": 123,\n  \"ScriptId\": 123,\n  \"ResponseShipmentId\": 123,\n  \"Active\": true,\n  \"Expires\": \"2023-11-07T05:31:56Z\",\n  \"MaxSubmits\": 123,\n  \"Recipe\": \"<string>\",\n  \"GroupId\": 123,\n  \"NewTicket\": true,\n  \"Registered\": \"2023-11-07T05:31:56Z\",\n  \"RegisteredAssociateId\": 123,\n  \"Updated\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAssociateId\": 123,\n  \"UpdatedCount\": 123,\n  \"EmailFlows\": [\n    123\n  ],\n  \"FolderName\": \"<string>\",\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\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({
    FormId: 123,
    FormKey: '<string>',
    Name: '<string>',
    Description: '<string>',
    Config: '<string>',
    FolderId: 123,
    ScriptId: 123,
    ResponseShipmentId: 123,
    Active: true,
    Expires: '2023-11-07T05:31:56Z',
    MaxSubmits: 123,
    Recipe: '<string>',
    GroupId: 123,
    NewTicket: true,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    EmailFlows: [123],
    FolderName: '<string>',
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/Agents/Marketing/SaveFormEntity', 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/Marketing/SaveFormEntity",
  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([
    'FormId' => 123,
    'FormKey' => '<string>',
    'Name' => '<string>',
    'Description' => '<string>',
    'Config' => '<string>',
    'FolderId' => 123,
    'ScriptId' => 123,
    'ResponseShipmentId' => 123,
    'Active' => true,
    'Expires' => '2023-11-07T05:31:56Z',
    'MaxSubmits' => 123,
    'Recipe' => '<string>',
    'GroupId' => 123,
    'NewTicket' => true,
    'Registered' => '2023-11-07T05:31:56Z',
    'RegisteredAssociateId' => 123,
    'Updated' => '2023-11-07T05:31:56Z',
    'UpdatedAssociateId' => 123,
    'UpdatedCount' => 123,
    'EmailFlows' => [
        123
    ],
    'FolderName' => '<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/Marketing/SaveFormEntity"

payload = {
    "FormId": 123,
    "FormKey": "<string>",
    "Name": "<string>",
    "Description": "<string>",
    "Config": "<string>",
    "FolderId": 123,
    "ScriptId": 123,
    "ResponseShipmentId": 123,
    "Active": True,
    "Expires": "2023-11-07T05:31:56Z",
    "MaxSubmits": 123,
    "Recipe": "<string>",
    "GroupId": 123,
    "NewTicket": True,
    "Registered": "2023-11-07T05:31:56Z",
    "RegisteredAssociateId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "UpdatedAssociateId": 123,
    "UpdatedCount": 123,
    "EmailFlows": [123],
    "FolderName": "<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({
    FormId: 123,
    FormKey: '<string>',
    Name: '<string>',
    Description: '<string>',
    Config: '<string>',
    FolderId: 123,
    ScriptId: 123,
    ResponseShipmentId: 123,
    Active: true,
    Expires: '2023-11-07T05:31:56Z',
    MaxSubmits: 123,
    Recipe: '<string>',
    GroupId: 123,
    NewTicket: true,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    EmailFlows: [123],
    FolderName: '<string>',
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

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

{
  "FormId": 123,
  "FormKey": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "Config": "<string>",
  "FolderId": 123,
  "ScriptId": 123,
  "ResponseShipmentId": 123,
  "Active": true,
  "Expires": "2023-11-07T05:31:56Z",
  "MaxSubmits": 123,
  "Type": "Normal",
  "Recipe": "<string>",
  "GroupId": 123,
  "NewTicket": true,
  "RecaptchaMode": "NotAvailable",
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociateId": 123,
  "Updated": "2023-11-07T05:31:56Z",
  "UpdatedAssociateId": 123,
  "UpdatedCount": 123,
  "EmailFlows": [
    123
  ],
  "FolderName": "<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.

Body

The FormEntity that is saved

Definition and configuration of a Form Carrier object for FormEntity. Services for the FormEntity Carrier is available from the Marketing Agent.

FormId

integer<int32>

Primary key

FormKey

string

A short string used as unique id to access this form

Name

string

The name of this form

Description

string

Detailed description

Config

string

The JSON-formatted config of this form

FolderId

integer<int32>

The folder which this form belongs to. -1 indicates that the shipment is on the root

ScriptId

integer<int32>

The CRMScript Macro which will be run when the form is submitted.

ResponseShipmentId

integer<int32>

The id of the s_shipment that is used to send the response mails

Active

boolean

Indicates if this form is active or not

Expires

string<date-time>

After this datetime, the form will become inactive

MaxSubmits

integer<int32>

After this number of submits, the form will become inactive

Type

enum<string>

What kind of form is this? Indicates if this is a normal form or a template

Available options:

Normal,

Template

Recipe

string

The JSON-formatted recipe of this form

GroupId

integer<int32>

The group which this form belongs to.

NewTicket

boolean

Indicates if this form creates a ticket or not

RecaptchaMode

enum<string>

What is the state of the recaptcha configuration? This is a read-only member

Available options:

NotAvailable,

GlobalKeysExist,

KeysNeeded

Registered

string<date-time>

Registered when in UTC.

RegisteredAssociateId

integer<int32>

Registered by whom

Updated

string<date-time>

Last updated when in UTC.

UpdatedAssociateId

integer<int32>

Last updated by whom

UpdatedCount

integer<int32>

Number of updates made to this record

EmailFlows

integer<int32>[]

EmailFlows this form is used in (read-only)

FolderName

string

The name of the folder for this form

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

Response

Definition and configuration of a Form Carrier object for FormEntity. Services for the FormEntity Carrier is available from the Marketing Agent.

FormId

integer<int32>

Primary key

FormKey

string

A short string used as unique id to access this form

Name

string

The name of this form

Description

string

Detailed description

Config

string

The JSON-formatted config of this form

FolderId

integer<int32>

The folder which this form belongs to. -1 indicates that the shipment is on the root

ScriptId

integer<int32>

The CRMScript Macro which will be run when the form is submitted.

ResponseShipmentId

integer<int32>

The id of the s_shipment that is used to send the response mails

Active

boolean

Indicates if this form is active or not

Expires

string<date-time>

After this datetime, the form will become inactive

MaxSubmits

integer<int32>

After this number of submits, the form will become inactive

Type

enum<string>

What kind of form is this? Indicates if this is a normal form or a template

Available options:

Normal,

Template

Recipe

string

The JSON-formatted recipe of this form

GroupId

integer<int32>

The group which this form belongs to.

NewTicket

boolean

Indicates if this form creates a ticket or not

RecaptchaMode

enum<string>

What is the state of the recaptcha configuration? This is a read-only member

Available options:

NotAvailable,

GlobalKeysExist,

KeysNeeded

Registered

string<date-time>

Registered when in UTC.

RegisteredAssociateId

integer<int32>

Registered by whom

Updated

string<date-time>

Last updated when in UTC.

UpdatedAssociateId

integer<int32>

Last updated by whom

UpdatedCount

integer<int32>

Number of updates made to this record

EmailFlows

integer<int32>[]

EmailFlows this form is used in (read-only)

FolderName

string

The name of the folder for this form

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