GET marketing-campaigns/{id}

Gets marketing campaign details

Request

URL ( requires authentication )

https://api.crexi.com/marketing-campaigns/{id}

Parameters

id

integer

Campaign Id

Required

Response

Details

Returns an HTTP 200 OK and if operation was successful. Returns 400 Bad Request and an error message otherwise.

Data fields

AssetIds

Collection of integer

AssetLinksClicked

integer

BrokerIds

Collection of integer

ButtonColor

string

CCEmails

string

Clicked

integer

ClientEmails

string

CreatedOn

date

Creator

UserInfoData

DDLinksClicked

integer

Delivered

integer

Disclaimer

string

EmailListNeedsCleanUp

boolean

EmailLists

Collection of EmailListInfoData

EmailTitle

string

Id

integer

ImageFile

AttachmentData

ImageLinks

Collection of ImageLinkData

IsDraft

boolean

IsScheduled

boolean

MDLinksClicked

integer

NumberOfAssets

integer

NumberOfCampaigns

integer

Opened

integer

OriginalFile

AttachmentData

ReplyToEmail

string

Requested

integer

ScheduledFor

date

SecondButtonColor

string

SenderName

string

Sent

integer

SentOn

date

ShareMessage

string

Subject

string

TemplateType

string

UserCanDownloadReport

boolean

Example

JSON

{
  "AssetIds": [
    1,
    12
  ],
  "AssetLinksClicked": 14,
  "BrokerIds": [
    116,
    14
  ],
  "ButtonColor": "#2e8ddd",
  "CCEmails": "cc@email.net",
  "Clicked": 10,
  "ClientEmails": "recipient@test.com",
  "CreatedOn": "2019-06-12T11:38:51.6430138Z",
  "Creator": {
    "Email": "john@gmail.com",
    "FirstName": "John",
    "Id": 12345,
    "IndustryRoles": [
      "Lender",
      "Third Party Service"
    ],
    "LastName": "Backer",
    "Phone": "+17905123456",
    "ThumbnailUrl": "http://qwerty.qwe/user/12345/tn.jpg"
  },
  "DDLinksClicked": 7,
  "Delivered": 2,
  "Disclaimer": "This is Disclaimer",
  "EmailListNeedsCleanUp": false,
  "EmailLists": [
    {
      "Id": 1,
      "Name": "Recipients Sample List"
    }
  ],
  "EmailTitle": "Investment Highlights",
  "Id": 1,
  "ImageFile": {
    "ContentId": "c05f9e1e-a6a1-49ad-bc22-a51a767fbf78",
    "CreatedOn": "0001-01-01T00:00:00",
    "Filename": "Attach1.doc"
  },
  "ImageLinks": [
    {
      "AssetId": 12,
      "Bottom": 50,
      "Left": 100,
      "Right": 50,
      "Top": 100,
      "UrlType": "AssetDetails"
    }
  ],
  "IsDraft": true,
  "IsScheduled": true,
  "MDLinksClicked": 4,
  "NumberOfAssets": 5,
  "NumberOfCampaigns": 0,
  "Opened": 0,
  "OriginalFile": {
    "ContentId": "cf771bd1-406e-4373-8603-d061c96c6396",
    "CreatedOn": "0001-01-01T00:00:00",
    "Filename": "Attach2.png"
  },
  "ReplyToEmail": "reply_me@test.com",
  "Requested": 0,
  "ScheduledFor": "2019-06-07T11:38:51.6430138Z",
  "SecondButtonColor": "#d4d4d4",
  "SenderName": "Test Team",
  "Sent": 3,
  "SentOn": "2019-06-07T11:38:51.6430138Z",
  "ShareMessage": "This is share message",
  "Subject": "Subject",
  "TemplateType": "SingleProperty",
  "UserCanDownloadReport": true
}