PUT TriggerScript/{id}
Some tooltip text!
• 4 minutes to read
• 4 minutes to read
PUT /api/v1/TriggerScript/{id}
Updates the existing TriggerScriptEntity
Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.
Path Part | Type | Description |
---|---|---|
id | int32 | The TriggerScriptEntity id to update. Required |
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. |
PUT /api/v1/TriggerScript/{id}?$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: entity
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:
TriggerScriptEntity updated.
Response | Description |
---|---|
200 | TriggerScriptEntity updated. |
400 | Bad request. Entity to save is not in request body. |
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
PUT /api/v1/TriggerScript/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8
{
"ScreenChooserId": 863,
"Name": "Yundt LLC",
"ScreenType": "ChatAfterSaveNewMessage",
"Enabled": false,
"UniqueIdentifier": "sed",
"Source": "aut",
"Registered": "2010-08-13T03:45:28.7952992+02:00",
"RegisteredAssociateId": 283,
"Updated": "2004-03-03T03:45:28.7952992+01:00",
"UpdatedAssociateId": 851
}
Sample response
HTTP/1.1 200 TriggerScriptEntity updated.
Content-Type: application/json; charset=utf-8
{
"ScreenChooserId": 358,
"Name": "Olson Inc and Sons",
"ScreenType": "ChatAfterSaveNewMessage",
"Enabled": false,
"UniqueIdentifier": "ratione",
"Source": "est",
"Registered": "1999-03-27T03:45:28.7952992+01:00",
"RegisteredAssociateId": 547,
"Updated": "2017-04-01T03:45:28.7952992+02:00",
"UpdatedAssociateId": 618,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 328
}
},
"_Links": {
"Self": "https://www.example.com/api/v1/project/321",
"Archive": "https://www.example.com/api/v1/project"
}
}