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": "ad065b13-fdf1-4570-a1c1-2c95f193d5fd",
"UseLeadCardImage": true,
"SendFrom": "sample string 5",
"SendAt": "2026-05-10T05:09:51.4126436-07:00",
"DelayNumberOfDays": 1,
"CreatedBy": 1,
"CreatedDate": "2026-05-10T05:09:51.4126436-07:00",
"ChangedBy": 1,
"ChangedDate": "2026-05-10T05:09:51.4126436-07:00",
"StatusId": 1,
"JobSequence": 1,
"WaitingToReceive": 1,
"SentFromEmail": "sample string 6",
"SendAtTime": 5,
"StartAtTime": 5,
"EndAtTime": 5,
"IsLeadImage": true,
"IsNewImage": true,
"NewImageGuidId": "b1d4af05-43f1-4c6e-b0d1-6281c7a96a62",
"SentAt": "2026-05-10T05:09:51.4126436-07:00",
"SendFromPhone": "sample string 7",
"ImageFileName": "sample string 8",
"StartSendTime": "2026-05-10T05:09:51.4126436-07:00",
"EndSendTime": "2026-05-10T05:09:51.4126436-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": "04666a93-4305-4db3-acd4-cd99c475b641",
"UseLeadCardImage": true,
"SendFrom": "sample string 5",
"SendAt": "2026-05-10T05:09:51.4126436-07:00",
"DelayNumberOfDays": 1,
"CreatedBy": 1,
"CreatedDate": "2026-05-10T05:09:51.4126436-07:00",
"ChangedBy": 1,
"ChangedDate": "2026-05-10T05:09:51.4126436-07:00",
"StatusId": 1,
"JobSequence": 1,
"WaitingToReceive": 1,
"SentFromEmail": "sample string 6",
"SendAtTime": 5,
"StartAtTime": 5,
"EndAtTime": 5,
"IsLeadImage": true,
"IsNewImage": true,
"NewImageGuidId": "96098b5f-9c36-468c-a695-d7c6134e9227",
"SentAt": "2026-05-10T05:09:51.4126436-07:00",
"SendFromPhone": "sample string 7",
"ImageFileName": "sample string 8",
"StartSendTime": "2026-05-10T05:09:51.4126436-07:00",
"EndSendTime": "2026-05-10T05:09:51.4126436-07:00",
"IsQuietHours": true
}