PUT marketing-campaigns/{id}

Create and update/send a draft marketing campaign

Request

URL ( requires authentication )

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

Parameters

id

integer

Required

Body Parameters

AssetIds

Collection of integer

Required

Min length: 1

BrokerIds

Collection of integer

Optional

ButtonColor

string

Optional

Max length: 20

CCEmails

string

Optional

ClientEmails

string

Optional

CSVFile

Attachment

Optional

Disclaimer

string

Optional

Max length: 500

EmailListIds

Collection of integer

Optional

EmailTitle

string

Optional

Max length: 40

ImageFileId

globally unique identifier

Optional

ImageLinks

Collection of ImageLinkParameters

Optional

IsDraft

boolean

Optional

IsTest

boolean

Optional

OriginalFileId

globally unique identifier

Optional

ReplyToEmail

string

Optional

Max length: 64

Valid email address

ScheduledFor

date

Optional

SecondButtonColor

string

Optional

Max length: 20

SenderName

string

Optional

Max length: 100

ShareMessage

string

Optional

Max length: 2000

Subject

string

Required

Max length: 500

TemplateType

string

Optional

Possible values are: 'SingleProperty', 'MultipleProperty1', 'MultipleProperty2', 'ImageTemplate'

Example

JSON

{
  "AssetIds": [
    1,
    2,
    3,
    4,
    5
  ],
  "ButtonColor": "#2e8ddd",
  "CCEmails": "cc1@example.com,cc2@example.com",
  "ClientEmails": "client1@example.com,client2@example.com",
  "Disclaimer": "Disclaimer goes here",
  "EmailListIds": [
    11,
    23,
    35
  ],
  "EmailTitle": "Investment Highlights",
  "ImageFileId": "7ed7efd5-6154-4a1c-be99-71ffb183979f",
  "ImageLinks": [
    {
      "AssetId": 11,
      "Bottom": 30,
      "Left": 15,
      "Right": 50,
      "Top": 12,
      "UrlType": "MarketingDocument"
    }
  ],
  "IsDraft": false,
  "IsTest": false,
  "OriginalFileId": "6bf90a8c-60d9-4e0d-986b-111416f81be6",
  "ScheduledFor": "2019-10-23T07:20:56.8757634Z",
  "SecondButtonColor": "#b4b4b4",
  "ShareMessage": "This is share message",
  "TemplateType": "SingleProperty"
}

Response

Details

Returns an HTTP 200 OK and a draft marketing campaign id if operation was successful. Returns 400 Bad Request and an error message otherwise.

Example

JSON

1