Campaign trigger
Method: list
Authorization is required. The campaign triggers are list of prebuild rules, which can trigger an email campaign execution
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/campaign/trigger/list/{groupId}
Parameters
property | value | description |
---|---|---|
groupId | guid | The ID of the group, which triggers you want to review. |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{ "success": true, "message": "Esse anim incididunt duis nostrud veniam nisi ut non in duis dolor cupidatat enim.", "timestamp": "2014-03-03T23:20:23Z", "errors": {}, "object": { "offset": 0, "triggers": [ { "id": 1, "type": "campaignTrigger", "name": "Inactive Users", "description": "Fires when there are users inactive for more than 60 days. These users will recieve email. There is no need to add mail campaign, just attach this trigger to a template.", "group": { "id": "83acbf0f-b920-4ecb-a61e-e85bbfaaa52f", "name": "ea", "slug": "Home", "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png", "url": "http://demo.hivesocialnow.com/Home/" }, "accessWarnings": [] } ] } }
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
property | value | description |
---|---|---|
id | integer | The trigger id |
group | object | Some common properties of the user that performed the action: id, name, slug, thumbUrl, url (of the group home page) |
name | string | the trigger's name |
description | string | Description of what the trigger do |