API: POST Campaign

Overview

A campaign is the total marketing budget for a given card-linked offer. It can be 1:1 with an offer in the Banyan platform, or it can be 1:many, campaigns to offers. For example, if you wanted to test two different regions with different offers using the same marketing budget, you would set up a single campaign within the Banyan network and two different offers.

Banyan has an internal ID created by POST-ing to the /campaign endpoint with your Banyan ID. You will then include the byn_campaign_id returned in the response when setting up your offers.

📘

Note: CLOs with Banyan are typically priced per campaign, not offer.

URL

api.banyan.com/rest/v1/campaign

Body

NameDescriptionTypeNotes
byn_publisher_idThe ID given to your organization from BanyanNumericReach out to your Customer Support representative if you are unsure what your byn_publisher_id is

Example:

POST http://api.banyan.com/rest/v1/campaign
Bearer: {token_id}
Content-Type: application/json
Accept: application/json

{
    "byn_publisher_id": 106
}

Response

Example:

POST http://api.banyan.com/rest/v1/campaign
Bearer: {token_id}
Content-Type: application/json
Accept: application/json

{
    "data": [
        {
            "id": "cf8f9c27-f1da-580f-9316-3350333d234c",
            "byn_publisher_id": 106,
            "created_ts": "2022-12-06T21:41:36.422056Z"
        }
    ],
    "errors": []
}