Campaign

Methods for retrieving marketing and promotional campaign data, either by ID or a unique key.

getByID

Gets campaign object by campaign ID

Example

window.Pelcro.campaign.getByID({
    auth_token: window.Pelcro.user.read().auth_token,
    campaign_id: 1,
}, (error, response) => {
    if (error) {
        return console.log("error", error.message);
    }

    const campaign = response.data;
    console.log(campaign);
})

Parameters

ParameterType
auth_token String
campaign_id Number

getByKey

Gets campaign object by campaign Key

Example

window.Pelcro.campaign.getByKey({
    auth_token: window.Pelcro.user.read().auth_token,
    campaign_key: 1,
}, (error, response) => {
    if (error) {
        return console.log("error", error.message);
    }
    const campaign = response.data;
    console.log(campaign);
})

Parameters

ParameterType
auth_token String
campaign_key Number