| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read |
| POST | /company/{companyId}/incentives/{incentiveId} | Logs a user interaction with an incentive. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | path | Guid | Yes | The id of the company. If not provided, the company associated with the authenticated user will be used. |
| IncentiveId | path | int | Yes | The id of the incentive. |
| EngagementType | body | EngagementType | Yes | Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive. |
| Name | Value | |
|---|---|---|
| Read | 1 | |
| Success | 2 | |
| Cancelled | 3 | |
| CheckLater | 4 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /company/{companyId}/incentives/{incentiveId} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"IncentiveId":0,"EngagementType":"Read"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{}