CampaignSubscriber allows users to add subscribers to existing campaigns. See below some considerations for CampaignSubscriber :

This specific object does not have a Key for each entry, its identified by the combination of both subscriber (AbEntryKey) and campaign (CampaignKey).\
The field Key correspond to the subscriber (AbEntryKey).\
The field ParentKey correspond to the campaign (CampaignKey).\
There are multiple status available for a subscriber (for newly created subscribers we use new)
- New = 1\
- InProgress = 2\
- Complete = 3\
- Retry = 4\
- Unsubscribed = 5\
- SuspendedByFatalErr = 6\
- SuspendedManually = 16\
- Failed = 99\
- TestNew = 7\
- TestInProgress = 102\
- TestComplete = 8\
- TestRetry = 103\
- TestSuspendedManually = 9\
- TestUnsubscribed = 105\
- TestFailed = 100\

This object is currently in beta version but basic funtionality has been tested and is working properly, any feedback is appreciated.

MetaData

Read CampaignSubscriber metadata (simple)

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

Read CampaignSubscriber 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,
                "Sortable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "HasOption": 1,
                "DisplayValue": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/CampaignSubscriber"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

CampaignSubscriber CRUD

Read - CampaignSubscriber

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "CampaignSubscriber": {
        "Scope": {
            "Fields": {
                "Key": 1, // AbEntryKey of the subscriber
                "ParentKey": 1, // CampaignKey the AbEntry is subscribed to
                "StartDate": 1, // Date subscription started
                "NextDate": 1,
                // Status of the subscriber
                // New = 1
                // InProgress = 2
                // Complete = 3
                // Retry = 4
                // Unsubscribed = 5
                // SuspendedByFatalErr = 6
                // SuspendedManually = 16
                // Failed = 99
                // TestNew = 7
                // TestInProgress = 102
                // TestComplete = 8
                // TestRetry = 103
                // TestSuspendedManually = 9
                // TestUnsubscribed = 105
                // TestFailed = 100
                "Status": 1
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    }
}

Create - CampaignSubscriber

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "CampaignSubscriber": {
        "Data": {
            // AbEntryKey to subscribe
            "Key": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE=", // Mandatory
            // CampaignKey to subscribe the AbEntry to
            "ParentKey": "Q2FtcGFpZ24JMjQwNzI0MDAwMDAwMzMxMzcwNDYxME0JMA==", // Mandatory
            "StartDate": "2024-07-26T00:00:00", // Date subscription started (use current date)
            "NextDate": "2024-07-26T00:00:00", // Use same StartDate
            // Status of the subscriber
            // New = 1
            // InProgress = 2
            // Complete = 3
            // Retry = 4
            // Unsubscribed = 5
            // SuspendedByFatalErr = 6
            // SuspendedManually = 16
            // Failed = 99
            // TestNew = 7
            // TestInProgress = 102
            // TestComplete = 8
            // TestRetry = 103
            // TestSuspendedManually = 9
            // TestUnsubscribed = 105
            // TestFailed = 100
            "Status": 1 // Use 1 for new entries
        }
    }
}

Delete - CampaignSubscriber

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
// This will remove one entry based on the AbEntry - Campaign pair
{
    "CampaignSubscriber": {
        "Data": {
            // AbEntryKey of the subscriber
            "Key": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE=", // Mandatory
            // CampaignKey the AbEntry is subscribed to
            "ParentKey": "Q2FtcGFpZ24JMjQwNzI0MDAwMDAwMzMxMzcwNDYxME0JMA==" // Mandatory
        }
    }
}