POST api/CampaignMessage/GetCampaignMessage
Request Information
URI Parameters
None.
Body Parameters
CampaignDetailDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| MessageTitle | string |
None. |
|
| CampaignId | integer |
None. |
|
| MessageTemplate | string |
None. |
|
| ImageGuid | globally unique identifier |
None. |
|
| UseLeadCardImage | boolean |
None. |
|
| SendFrom | string |
None. |
|
| SendAt | date |
None. |
|
| DelayNumberOfDays | integer |
None. |
|
| CreatedBy | integer |
None. |
|
| CreatedDate | date |
None. |
|
| ChangedBy | integer |
None. |
|
| ChangedDate | date |
None. |
|
| StatusId | integer |
None. |
|
| JobSequence | integer |
None. |
|
| WaitingToReceive | integer |
None. |
|
| SentFromEmail | string |
None. |
|
| SendAtTime | integer |
None. |
|
| StartAtTime | integer |
None. |
|
| EndAtTime | integer |
None. |
|
| IsLeadImage | boolean |
None. |
|
| IsNewImage | boolean |
None. |
|
| NewImageGuidId | globally unique identifier |
None. |
|
| SentAt | date |
None. |
|
| SendFromPhone | string |
None. |
|
| ImageFileName | string |
None. |
|
| StartSendTime | date |
None. |
|
| EndSendTime | date |
None. |
|
| IsQuietHours | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"MessageTitle": "sample string 2",
"CampaignId": 1,
"MessageTemplate": "sample string 3",
"ImageGuid": "8f0d8e60-30f4-45e2-988e-6ee5534507d3",
"UseLeadCardImage": true,
"SendFrom": "sample string 5",
"SendAt": "2026-06-25T12:33:28.9191728-07:00",
"DelayNumberOfDays": 1,
"CreatedBy": 1,
"CreatedDate": "2026-06-25T12:33:28.9191728-07:00",
"ChangedBy": 1,
"ChangedDate": "2026-06-25T12:33:28.9191728-07:00",
"StatusId": 1,
"JobSequence": 1,
"WaitingToReceive": 1,
"SentFromEmail": "sample string 6",
"SendAtTime": 12,
"StartAtTime": 12,
"EndAtTime": 12,
"IsLeadImage": true,
"IsNewImage": true,
"NewImageGuidId": "9ab6d97a-2b9e-406b-80ca-17b45e847b7c",
"SentAt": "2026-06-25T12:33:28.9191728-07:00",
"SendFromPhone": "sample string 7",
"ImageFileName": "sample string 8",
"StartSendTime": "2026-06-25T12:33:28.9191728-07:00",
"EndSendTime": "2026-06-25T12:33:28.9291937-07:00",
"IsQuietHours": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CampaignDetailDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| MessageTitle | string |
None. |
|
| CampaignId | integer |
None. |
|
| MessageTemplate | string |
None. |
|
| ImageGuid | globally unique identifier |
None. |
|
| UseLeadCardImage | boolean |
None. |
|
| SendFrom | string |
None. |
|
| SendAt | date |
None. |
|
| DelayNumberOfDays | integer |
None. |
|
| CreatedBy | integer |
None. |
|
| CreatedDate | date |
None. |
|
| ChangedBy | integer |
None. |
|
| ChangedDate | date |
None. |
|
| StatusId | integer |
None. |
|
| JobSequence | integer |
None. |
|
| WaitingToReceive | integer |
None. |
|
| SentFromEmail | string |
None. |
|
| SendAtTime | integer |
None. |
|
| StartAtTime | integer |
None. |
|
| EndAtTime | integer |
None. |
|
| IsLeadImage | boolean |
None. |
|
| IsNewImage | boolean |
None. |
|
| NewImageGuidId | globally unique identifier |
None. |
|
| SentAt | date |
None. |
|
| SendFromPhone | string |
None. |
|
| ImageFileName | string |
None. |
|
| StartSendTime | date |
None. |
|
| EndSendTime | date |
None. |
|
| IsQuietHours | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"MessageTitle": "sample string 2",
"CampaignId": 1,
"MessageTemplate": "sample string 3",
"ImageGuid": "f2bf5bd9-b96b-4440-be38-87a733aa8df3",
"UseLeadCardImage": true,
"SendFrom": "sample string 5",
"SendAt": "2026-06-25T12:33:28.9313615-07:00",
"DelayNumberOfDays": 1,
"CreatedBy": 1,
"CreatedDate": "2026-06-25T12:33:28.9313615-07:00",
"ChangedBy": 1,
"ChangedDate": "2026-06-25T12:33:28.9313615-07:00",
"StatusId": 1,
"JobSequence": 1,
"WaitingToReceive": 1,
"SentFromEmail": "sample string 6",
"SendAtTime": 12,
"StartAtTime": 12,
"EndAtTime": 12,
"IsLeadImage": true,
"IsNewImage": true,
"NewImageGuidId": "18a3aeb9-1125-42bf-9e77-8bbd901695ef",
"SentAt": "2026-06-25T12:33:28.9313615-07:00",
"SendFromPhone": "sample string 7",
"ImageFileName": "sample string 8",
"StartSendTime": "2026-06-25T12:33:28.9313615-07:00",
"EndSendTime": "2026-06-25T12:33:28.9313615-07:00",
"IsQuietHours": true
}