Campaign allows users to manage marketing campaigns in Maximizer CRM. See below some considerations for Campaign:

A campaign can have one of below available status
- New = 0\
- In Progress = 2\
- Completed = 3\
- Abandoned = 5\
- Suspended = 6\
A campaign can be of one of below types
- Fixed-Date Automated Campaign = 10\
- Ongoing Automated Campaign = 15\
- Campaign = 25

HowTo's

Read - Campaign using $PHRASE operator

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Campaign": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Status": 1,
                "Name": 1,
                "Type": 1,
                "Description": 1,
                "Cost": 1,
                "ForecastRevenue": 1,
                "ActualRevenue": 1,
                "StartDate": 1,
                "EndDate": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "$PHRASE": "email campaign" //$PHRASE operator will search on Name and Description properties
            }
        }
    }
}

MetaData

Read Campaign metadata (simple)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": 1
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/Campaign"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read Campaign metadata (more)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Alias": 1,
                "Type": 1,
                "Name": 1,
                "AppliesTo": 1,
                "HasOption": 1,
                "Sortable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "DisplayValue": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/Campaign"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Field Options

Read Campaign FieldOptions - Status

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Campaign": {
        "FieldOptions": {
            "Status": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read Campaign FieldOptions - Type

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Campaign": {
        "FieldOptions": {
            "Type": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Campaign CRUD

Create - Campaign

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "Campaign": {
        "Data": {
            "Key": null,
            "Name": "Email Campaign For Renewals",
            // Statuses supported
            // 0: "New"
            // 2: "In progress"
            // 3: "Completed"
            // 5: "Abandoned"
            // 6: "Suspended"
            "Status": 0,
            // Type of Campaigns supported
            // 10: "Fixed-Date Automated Campaign"
            // 15: "Ongoing Automated Campaign"
            // 25: "Campaign"
            "Type": 15,
            "Description": "This is a campaign to send automated emails related to subscription renewals",
            "Cost": 1500.0,
            "ForecastRevenue": 7000.0,
            "ActualRevenue": 0.0,
            "StartDate": "2022-01-01",
            "EndDate": "2022-03-31"
        }
    }
}

Read - Campaign

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Campaign": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Status": {
                    "DisplayValue": 1
                },
                "Name": 1,
                "Type": {
                    "DisplayValue": 1
                },
                "Description": 1,
                "Cost": 1,
                "ForecastRevenue": 1,
                "ActualRevenue": 1,
                "StartDate": 1,
                "EndDate": 1
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    }
}

Update - Campaign

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "Campaign": {
        "Data": {
            "Key": "Q2FtcGFpZ24JMjQwNzI0MDAwMDAwMzMxMzcwNDYxME0JMA==", // Mandatory
            "Name": "SMS campaign for renewals",
            // Statuses supported
            // 0: "New"
            // 2: "In progress"
            // 3: "Completed"
            // 5: "Abandoned"
            // 6: "Suspended"
            "Status": 2,
            // Type of Campaigns supported
            // 10: "Fixed-Date Automated Campaign"
            // 15: "Ongoing Automated Campaign"
            // 25: "Campaign"
            "Type": 15,
            "Description": "Campaign for sending recurring SMS",
            "Cost": 100.0,
            "ForecastRevenue": 700.0,
            "ActualRevenue": 800.0,
            "StartDate": "2023-01-01",
            "EndDate": "2023-03-31"            
        }
    }
}

Delete - Campaign

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "Campaign": {
        "Data": {
            "Key": "Q2FtcGFpZ24JMjIwNzEzMDAyMTAwNzcyMjM4MTY5TQkw" // Mandatory
        }
    }
}