Promotion
Reference for the promotion endpoints of the Interact REST API.
Note: All endpoints require authentication and an
X-Tenantheader. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.
Endpoints on this page
GET /api/promotions/analytics
List analytics.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pageId |
query | integer (int32) | Yes | |
organisationId |
query | integer (int32) | No | |
sortColumn |
query | string | No | |
sortDirection |
query | string | No | Allowed values: Ascending, Descending |
offset |
query | integer (int32) | No | |
limit |
query | integer (int32) | No |
Responses
| Status | Body |
|---|---|
| 200 | object |
GET /api/promotions/digest-analytics
List digest analytics.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
offset |
query | integer (int32) | No | |
limit |
query | integer (int32) | No | |
sortDirection |
query | string | No | Allowed values: Ascending, Descending |
Responses
| Status | Body |
|---|---|
| 200 | object |
DELETE /api/promotions/{promotionId}/cancel
Delete a cancel.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
promotionId |
path | integer (int64) | Yes |
Responses
| Status | Body |
|---|---|
| 200 | object |
GET /api/promotions/email/{contentId}/latest
List the latest emails.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
contentId |
path | integer (int32) | Yes |
Responses
| Status | Body |
|---|---|
| 200 | object |
Section: REST API