POST Agents/Marketing/GetFormEntity

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Marketing/GetFormEntity

Gets a FormEntity object.

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
formEntityId int32 Required The identifier of the FormEntity object
$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. 
POST /api/v1/Agents/Marketing/GetFormEntity?formEntityId=521
POST /api/v1/Agents/Marketing/GetFormEntity?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: FormEntity

Property Name Type Description
FormId 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 int32 The folder which this form belongs to. -1 indicates that the shipment is on the root
ScriptId int32 The CRMScript Macro which will be run when the form is submitted.
ResponseShipmentId int32 The id of the s_shipment that is used to send the response mails
Active bool Indicates if this form is active or not
Expires date-time After this datetime, the form will become inactive
MaxSubmits int32 After this number of submits, the form will become inactive
Type string What kind of form is this? Indicates if this is a normal form or a template
Recipe string The JSON-formatted recipe of this form
GroupId int32 The group which this form belongs to.
NewTicket bool Indicates if this form creates a ticket or not
RecaptchaMode string What is the state of the recaptcha configuration? This is a read-only member
Registered date-time Registered when in UTC.
RegisteredAssociateId int32 Registered by whom
Updated date-time Last updated when in UTC.
UpdatedAssociateId int32 Last updated by whom
UpdatedCount int32 Number of updates made to this record
EmailFlows array EmailFlows this form is used in (read-only)
FolderName string The name of the folder for this form
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Marketing/GetFormEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "FormId": 389,
  "FormKey": "contact-us-2024",
  "Name": "Contact Us Form",
  "Description": "Main contact form for website inquiries",
  "Config": "{\"fields\":[\"name\",\"email\",\"phone\",\"message\"]}",
  "FolderId": 129,
  "ScriptId": 102,
  "ResponseShipmentId": 213,
  "Active": true,
  "Expires": "2025-12-31T23:59:00.4273568+01:00",
  "MaxSubmits": 1000,
  "Type": "Normal",
  "Recipe": "StandardContactForm",
  "GroupId": 33,
  "NewTicket": true,
  "RecaptchaMode": "GlobalKeysExist",
  "Registered": "2024-01-15T10:11:00.4273568+01:00",
  "RegisteredAssociateId": 980,
  "Updated": "2024-11-20T10:11:00.4273568+01:00",
  "UpdatedAssociateId": 539,
  "UpdatedCount": 12,
  "EmailFlows": [
    240,
    4
  ],
  "FolderName": "Website Forms",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 679
    }
  }
}