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": "9897cf5c-4a9f-48c5-9aa4-9abb6bf1907e",
"UseLeadCardImage": true,
"SendFrom": "sample string 5",
"SendAt": "2026-09-24T15:32:34.0157863-07:00",
"DelayNumberOfDays": 1,
"CreatedBy": 1,
"CreatedDate": "2026-09-24T15:32:34.0157863-07:00",
"ChangedBy": 1,
"ChangedDate": "2026-09-24T15:32:34.0157863-07:00",
"StatusId": 1,
"JobSequence": 1,
"WaitingToReceive": 1,
"SentFromEmail": "sample string 6",
"SendAtTime": 15,
"StartAtTime": 15,
"EndAtTime": 15,
"IsLeadImage": true,
"IsNewImage": true,
"NewImageGuidId": "a560a296-3934-4613-9389-13ca129a39b0",
"SentAt": "2026-09-24T15:32:34.0157863-07:00",
"SendFromPhone": "sample string 7",
"ImageFileName": "sample string 8",
"StartSendTime": "2026-09-24T15:32:34.0157863-07:00",
"EndSendTime": "2026-09-24T15:32:34.0157863-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": "175f8926-3521-4686-b2b2-0f1d32f70435",
"UseLeadCardImage": true,
"SendFrom": "sample string 5",
"SendAt": "2026-09-24T15:32:34.0189725-07:00",
"DelayNumberOfDays": 1,
"CreatedBy": 1,
"CreatedDate": "2026-09-24T15:32:34.0189725-07:00",
"ChangedBy": 1,
"ChangedDate": "2026-09-24T15:32:34.0189725-07:00",
"StatusId": 1,
"JobSequence": 1,
"WaitingToReceive": 1,
"SentFromEmail": "sample string 6",
"SendAtTime": 15,
"StartAtTime": 15,
"EndAtTime": 15,
"IsLeadImage": true,
"IsNewImage": true,
"NewImageGuidId": "cbd42705-5873-4ee7-bcb8-f82d30f6b8f1",
"SentAt": "2026-09-24T15:32:34.0189725-07:00",
"SendFromPhone": "sample string 7",
"ImageFileName": "sample string 8",
"StartSendTime": "2026-09-24T15:32:34.0189725-07:00",
"EndSendTime": "2026-09-24T15:32:34.0189725-07:00",
"IsQuietHours": true
}