| POST | /thunderbolt/submit |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ActionId | body | int | No | |
| Platform | body | ContactInteractionPlatform | No | |
| Number | body | string | No | |
| body | string | No | ||
| Notes | body | string | No | |
| DateTime | body | DateTime | No | |
| ContactId | body | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Latitude | form | double | No | Latitude of the user making this request |
| Longitude | form | double | No | Longitude of the user making this request |
| Name | Value | |
|---|---|---|
| None | 0 | |
| 1 | ||
| Linkus | 2 | |
| Mobile | 3 | |
| Outlook | 4 | |
| 5 | ||
| Telegram | 6 | |
| Signal | 7 | |
| Sms | 8 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ThunderboltActionEventId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DailyActionsNumber | form | int | No | |
| SupportingDocumentProbability | form | int | No | |
| ThunderBoltActions | form | List<ThunderBoltActionData> | No | |
| ThunderBoltActionEvents | form | List<ThunderBoltActionEventData> | No | |
| Contacts | form | List<ContactData> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ActionName | form | string | No | |
| Color | form | string | No | |
| DailyActionCount | form | int | No | |
| ShowNumberInput | form | bool | No | |
| ShowEmailInput | form | bool | No | |
| ShowPlatformInput | form | bool | No | |
| ShowDateTimeInput | form | bool | No | |
| ContactInteractionPlatforms | form | List<EnumOption> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | int | No | |
| Label | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| CreatedDate | form | string | No | |
| ActionId | form | int | No | |
| ActionName | form | string | No | |
| Color | form | string | No | |
| Notes | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | int | No | |
| ContactName | form | string | No | |
| form | string | No | ||
| PhoneNumber | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /thunderbolt/submit HTTP/1.1
Host: cochraneplus-api-dev.happen.zone
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
actionId: 0,
platform: 0,
number: String,
email: String,
notes: String,
dateTime: 0001-01-01,
contactId: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
thunderboltActionEventId: 0,
dailyActionsNumber: 0,
supportingDocumentProbability: 0,
thunderBoltActions:
[
{
id: 0,
actionName: String,
color: String,
dailyActionCount: 0,
showNumberInput: False,
showEmailInput: False,
showPlatformInput: False,
showDateTimeInput: False,
contactInteractionPlatforms:
[
{
value: 0,
label: String
}
]
}
],
thunderBoltActionEvents:
[
{
id: 0,
createdDate: String,
actionId: 0,
actionName: String,
color: String,
notes: String
}
],
contacts:
[
{
}
],
description: String,
heading: String,
wasSuccessful: False,
modelState: {}
}