Skip to content

Create a New Action

Method: POST

Url: /Actions
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String: None

Request Body:

Parameter NameData TypeRemarks
IncidentID (required)IntegerThe ID of the incident
ActionDescription (required)StringThe action description. May contain HTML
NewContentInHTMLBooleanWhether the ActionDescription contains HTML

Default: True
CCWebUserIDIntegerThe ID of the user who added the action

Default: -1
CustomFieldsList<CustomField>List of custom fields (key-value pair) for this record
Request Example:
POST “https://api.dataprise.com/api/v1/Actions/”Header: “DPApiAuthenticationToken=abcxyz0123456789″Body: { “IncidentID”: 4321, “ActionDescription”: “Test action from API”, “NewContentInHTML”: false, “CustomFields”: [{“FieldLabel”: “Source”, “FieldValue”:”Email”}] }

Response:

The API will return the response as under:

PropertyData TypeRemarks
StatusStringStatus of the request. Either “Success” or “Failure”
MessageStringError messages if the request failed (i.e. Status = “Failure”)
IdIntegerThe ID of the created record if the request succeeded (i.e. Status = “Success”)
Sample Response:
{ “Status”: “Success”, “Message”: “”, “Id”: 415 }