getCampaignFolders

Description

Get a list of campaign folders.



Params

NameTypeDescription
apiKeystringAPI key previously generated.
offsetintegerOptional parameter to specify offset.
countintegerOptional parameter to specify the number of records.
idintegerOptional parameter to search by id.
namestringOptional parameter to search by name.
parentIdintegerOptional parameter to search by parentId, showing folders inside the specified id.
sortFieldstringOptional parameter to specify a search field.
sortOrderstringOptional parameter to specify a sort order. Accepted values are ASC and DESC (default).

 

Returned data

Type: array

Description: Return array with campaign folders data.

 

Json sample code

<?php

$curl = curl_init('https://your_address/ccm/admin/api/version/2/&type=json');

$postData = array(
    'function' => 'getCampaignFolders',
    'apiKey' => 'apiKey',
    'offset' => 0,
    'count' => 2,
);

curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$json = curl_exec($curl);
if ($json === false) {
    die('Request failed with error: '. curl_error($curl));
}

$result = json_decode($json);
if ($result->status == 0) {
    die('Bad status returned. Error: '. $result->error);
}

var_dump($result->data);

 

Result of API call

array(1) {
  [0]=>
  object(stdClass)#2 (3) {
    ["id"]=>
    string(1) "2"
    ["name"]=>
    string(7) "Example"
    ["parent_id"]=>
    string(1) "0"
  }
}