POST TriggerScript

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/TriggerScript

Creates a new TriggerScriptEntity

Calls the CRMScript agent service SaveTriggerScriptEntity.

Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.

Query String Parameters

Parameter Name Type Description
$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/TriggerScript?$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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: newEntity

The TriggerScriptEntity to be saved.

Property Name Type Description
ScreenChooserId Integer Primary key
Name String Optional description of what this script is used for.
ScreenType String Event id that triggers script. See EventHandlerType enum.
Enabled Boolean Whether this screen chooser is enabled or not
UniqueIdentifier String Global unique identifier, accross customers/tenants
Source String The CRMscript code for this event handler
Registered String Registered when in UTC.
RegisteredAssociateId Integer Registered by whom
Updated String Last updated when in UTC.
UpdatedAssociateId Integer Last updated by whom

Response:

OK

Response Description
200 OK

Response body: TriggerScriptEntityWithLinks

Property Name Type Description
ScreenChooserId int32 Primary key
Name string Optional description of what this script is used for.
ScreenType string Event id that triggers script. See EventHandlerType enum.
Enabled bool Whether this screen chooser is enabled or not
UniqueIdentifier string Global unique identifier, accross customers/tenants
Source string The CRMscript code for this event handler
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
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

POST /api/v1/TriggerScript
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ScreenChooserId": 101,
  "Name": "Kunze-Wolff",
  "ScreenType": "ChatAfterSaveNewMessage",
  "Enabled": false,
  "UniqueIdentifier": "adipisci",
  "Source": "inventore",
  "Registered": "2000-09-21T16:32:48.2745849+02:00",
  "RegisteredAssociateId": 621,
  "Updated": "2019-04-13T16:32:48.2745849+02:00",
  "UpdatedAssociateId": 373
}

Sample response

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

{
  "ScreenChooserId": 824,
  "Name": "Wilkinson Inc and Sons",
  "ScreenType": "ChatAfterSaveNewMessage",
  "Enabled": false,
  "UniqueIdentifier": "natus",
  "Source": "vel",
  "Registered": "2014-03-17T16:32:48.2745849+01:00",
  "RegisteredAssociateId": 47,
  "Updated": "2024-09-25T16:32:48.2745849+02:00",
  "UpdatedAssociateId": 628,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 826
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}