### GET /setup

Source: https://developers.voluum.com/

Retrieves the current client setup configuration, including domains, quotas, and tracking URLs.

```APIDOC
## GET /setup

### Description
Retrieves the comprehensive client setup configuration for the authenticated user, including domain settings, account quotas, and various tracking URLs.

### Method
GET

### Endpoint
/setup

### Response
#### Success Response (200)
- **antiFraudConfiguration** (object) - Anti Fraud Configuration settings
- **domains** (object) - Domain setup details including custom and dedicated domains
- **impressionPixelForwardingWhitelistedDomains** (Array[string]) - Whitelisted domains for impression pixel forwarding
- **landerProtectionKey** (string) - Key used for lander protection
- **quota** (object) - Account usage limits and entity quotas
- **realtimeRoutingApi** (object) - Realtime routing API configuration
- **rootRedirect** (object) - Root redirect settings
- **timeToInstallConfiguration** (object) - Time to install configuration
- **urls** (object) - Tracking, click, and postback URLs

#### Response Example
{
  "domains": {
    "dedicatedDomains": [],
    "defaultRedirectDomain": "track.example.com"
  },
  "quota": {
    "campaigns": 100,
    "landers": 50
  },
  "urls": {
    "clickUrl": "https://track.example.com/click",
    "postbackUrl": "https://track.example.com/postback"
  }
}
```

--------------------------------

### GET /websites/developers_voluum/core/setup

Source: https://developers.voluum.com/

Retrieves the client setup configuration for Voluum, including anti-fraud, domains, quotas, and more.

```APIDOC
## GET /websites/developers_voluum/core/setup

### Description
Retrieves the client setup configuration for Voluum. This includes details about anti-fraud settings, domain configurations, impression pixel forwarding, lander protection, quotas, real-time routing API, root redirect settings, time to install configuration, and URL setups.

### Method
GET

### Endpoint
/websites/developers_voluum/core/setup

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **core_setup_SetupResource** (object) - The client setup configuration.
  - **antiFraudConfiguration** (core_setup_ivt_AntiFraudConfigurationResource) - Anti Fraud Configuration.
  - **domains** (core_setup_DomainSetupResource) - Domains setup.
  - **impressionPixelForwardingWhitelistedDomains** (Array[string], optional) - Impression pixel forwarding whitelisted domains.
  - **landerProtectionKey** (string) - Lander protection key.
  - **quota** (core_setup_QuotaResource) - Elements limits.
  - **realtimeRoutingApi** (core_setup_RealtimeRoutingApiSetupResource) - Realtime routing API setup.
  - **rootRedirect** (core_setup_RootRedirectSetupResource, optional) - Root redirect setup.
  - **timeToInstallConfiguration** (core_setup_ivt_TimeToInstallConfigurationResource) - Time To Install Configuration.
  - **urls** (core_setup_UrlSetupResource) - Urls setup.

#### Response Example
```json
{
  "antiFraudConfiguration": {},
  "domains": {
    "customDomains": [],
    "dedicatedDomains": [],
    "defaultRedirectDomain": null,
    "internalDomains": [],
    "redirectDomain": null
  },
  "impressionPixelForwardingWhitelistedDomains": [],
  "landerProtectionKey": "example_key",
  "quota": {
    "adminWorkerUserLimit": 10,
    "affiliateNetworks": 100,
    "asyncReportsRequests": 500,
    "autoRules": 50,
    "campaigns": 200,
    "campaignsInAllFromTrafficSourceAutoRule": 10,
    "columnConditionsPerAutoRule": 20,
    "customDomainCertificates": 50,
    "customDomains": 100,
    "dedicatedDomains": 100,
    "dimensionLists": 50,
    "entitiesPerAutoRule": 30,
    "flows": 150,
    "ipRangesPerCondition": 100,
    "ipUaEntriesPerRule": 50,
    "ipUaRules": 50,
    "landers": 150,
    "memberUserLimit": 5,
    "offers": 150,
    "sharedReports": 20,
    "trafficLogDailyRequests": 10000,
    "trafficSources": 100,
    "valuesPerDimensionList": 100,
    "workspaces": 10
  },
  "realtimeRoutingApi": {
    "enabled": true,
    "url": "http://rt.example.com"
  },
  "rootRedirect": {
    "enabled": false,
    "url": null
  },
  "timeToInstallConfiguration": {},
  "urls": {
    "clickUrl": "http://example.com/click",
    "multiOfferClickUrl": "http://example.com/click/{offer_id}",
    "postbackUrl": "http://example.com/postback",
    "securePostbackUrl": "https://example.com/postback",
    "trackingPixelUrl": "http://example.com/pixel.gif",
    "trackingScriptUrl": "http://example.com/script.js"
  }
}
```
```

--------------------------------

### GET /core/setup

Source: https://developers.voluum.com/

Retrieves the core setup configuration including domain lists, tracking URLs, and account quotas.

```APIDOC
## GET /core/setup

### Description
Retrieves the complete configuration for the account, including domain settings (custom, dedicated, internal), tracking URLs (postback, pixel, script), and current usage quotas.

### Method
GET

### Endpoint
/core/setup

### Response
#### Success Response (200)
- **domains** (object) - Domain configuration object containing custom, dedicated, and internal domains.
- **urls** (object) - Tracking URLs including clickUrl, postbackUrl, and trackingScriptUrl.
- **quota** (object) - Current usage limits for campaigns, domains, and other entities.

#### Response Example
{
  "domains": {
    "customDomains": [
      {
        "address": "example.com",
        "mainDomain": true,
        "sslStatus": "ENABLED"
      }
    ]
  },
  "urls": {
    "trackingScriptUrl": "https://example.com/script.js",
    "postbackUrl": "https://example.com/postback"
  }
}
```

--------------------------------

### Retrieve Client Setup Configuration

Source: https://developers.voluum.com/

Represents the full client setup object, including domain lists, tracking URLs, and account usage quotas.

```json
{
  "domains": {
    "customDomains": [],
    "dedicatedDomains": [],
    "defaultRedirectDomain": "string"
  },
  "urls": {
    "clickUrl": "string",
    "postbackUrl": "string",
    "trackingPixelUrl": "string",
    "trackingScriptUrl": "string"
  },
  "quota": {
    "campaigns": 0,
    "offers": 0,
    "landers": 0
  }
}
```

--------------------------------

### Campaign Configuration Example

Source: https://developers.voluum.com/

An example of a Voluum campaign configuration object, including cost models, targeting parameters, and tracking details.

```json
{
  "banned": true,
  "clientId": "string",
  "costModel": {
    "customConversionCostConfiguration": {
      "customConversionCosts": [
        {
          "index": 0,
          "value": 0
        }
      ]
    },
    "trafficLossEnabled": true,
    "trafficLossRatio": 0,
    "type": "CPC",
    "value": 0
  },
  "country": {
    "code": "string",
    "name": "string"
  },
  "createdTime": "2026-03-26T22:04:30.688Z",
  "deleted": true,
  "directTracking": true,
  "directTrackingLanderId": "string",
  "directTrackingOfferId": "string",
  "id": "string",
  "impressionUrl": "string",
  "name": "string",
  "namePostfix": "string",
  "note": {
    "note": "string"
  },
  "pixelRedirectUrl": "string",
  "postbackUrl": "string",
  "preferredTrackingDomain": "string",
  "redirectTarget": {
    "flow": {
      "id": "string"
    },
    "inlineFlow": {
      "conditionalPathsGroups": [
        {
          "active": true,
          "conditions": {
            "brand": {
              "brandAndModels": [
                {
                  "brand": "string",
                  "model": "string"
                }
              ],
              "brands": [
                "string"
              ],
              "predicate": "MUST_BE"
            },
            "browser": {
              "browserAndVersions": [
                {
                  "browser": "string",
                  "version": "string"
                }
              ],
              "browsers": [
                "string"
              ],
              "predicate": "MUST_BE"
            },
            "city": {
              "names": [
                "string"
              ],
              "predicate": "MUST_BE"
            },
            "connectionType": {
              "predicate": "MUST_BE",
              "types": [
                "BROADBAND"
              ]
            },
            "country": {
              "countries": [
                {
                  "code": "string"
                }
              ]
            }
          }
        }
      ]
    }
  }
}
```

--------------------------------

### Client Setup Update API

Source: https://developers.voluum.com/

Updates the client setup for domains, real-time routing, and root redirect settings.

```APIDOC
## POST /websites/developers_voluum

### Description
Updates the client setup for domains, real-time routing API, and root redirect.

### Method
POST

### Endpoint
/websites/developers_voluum

### Parameters
#### Request Body
- **domains** (core_setup_DomainSetupUpdateResource, optional) - Domains setup
- **realtimeRoutingApi** (core_setup_RealtimeRoutingApiSetupUpdateResource, optional) - Realtime routing API setup
- **rootRedirect** (core_setup_RootRedirectSetupResource, optional) - Root redirect setup

### Request Example
```json
{
  "domains": {
    "customDomains": [
      {
        "address": "string",
        "workspaceIds": [
          "string"
        ]
      }
    ],
    "dedicatedDomains": [
      {
        "address": "string",
        "workspaceIds": [
          "string"
        ]
      }
    ],
    "mainDomain": "string",
    "redirectDomain": "string"
  },
  "realtimeRoutingApi": {
    "url": "string"
  },
  "rootRedirect": {
    "enabled": true,
    "url": "string"
  }
}
```

### Response
#### Success Response (200)
- **items** (Array[core_archive_ArchiveItemResource]) - List of items to be archived
- **status** (string) - Archive operation status. SUCCESSFUL - all entities successfully archived. FAILURE - all entities failed to archive. PARTIALLY_APPLIED - some of entities were successfully archived but some of them not

#### Response Example
```json
{
  "items": [
    {
      "error": "string",
      "id": "string",
      "name": "string",
      "references": [
        {
          "entityType": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "status": "SUCCESSFUL"
    }
  ],
  "status": "SUCCESSFUL"
}
```
```

--------------------------------

### Example User Response (JSON)

Source: https://developers.voluum.com/

An example JSON payload representing a user's details, including their ID, name, email, memberships, and role. This demonstrates the expected output for a successful user data retrieval.

```json
{
  "created": "2026-03-26T22:04:31.003Z",
  "currency": "string",
  "defaultClientId": "string",
  "email": "string",
  "emailChangeInProgress": true,
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "memberships": [
    {
      "client": {
        "created": "2026-03-26T22:04:31.003Z",
        "features": [
          "AFFILIATE_TRACKING"
        ],
        "id": "string",
        "initialPlan": "string",
        "name": "string",
        "phoneNumber": "string",
        "referrerToken": "string",
        "signUpPlan": "string"
      },
      "grantedPermissions": [
        "invitationManagement"
      ],
      "restrictedColumns": [
        {
          "name": "string"
        }
      ],
      "role": "OWNER"
    }
  ],
  "mfaActive": true,
  "passwordSet": true,
  "preferredClientId": "string",
  "role": "ROLE_ADMIN",
  "state": "NEW",
  "timezone": "UTC"
}
```

--------------------------------

### Update Client Setup Request (JSON)

Source: https://developers.voluum.com/

This JSON payload is used to update client setup configurations, including domains, real-time routing API, and root redirect settings. It defines the structure for various setup resources.

```json
{
  "domains": {
    "customDomains": [
      {
        "address": "string",
        "workspaceIds": [
          "string"
        ]
      }
    ],
    "dedicatedDomains": [
      {
        "address": "string",
        "workspaceIds": [
          "string"
        ]
      }
    ],
    "mainDomain": "string",
    "redirectDomain": "string"
  },
  "realtimeRoutingApi": {
    "url": "string"
  },
  "rootRedirect": {
    "enabled": true,
    "url": "string"
  }
}
```

--------------------------------

### Lander Resource Model and Example

Source: https://developers.voluum.com/

Defines the structure of a Lander resource, including its properties such as country, creation time, name, and URL. It also provides an example JSON object representing a Lander resource.

```json
{
  "country": {
    "code": "string",
    "name": "string"
  },
  "createdTime": "2026-03-26T22:04:30.810Z",
  "deleted": true,
  "id": "string",
  "landerType": "LANDER",
  "name": "string",
  "namePostfix": "string",
  "note": {
    "note": "string"
  },
  "numberOfOffers": 0,
  "preferredTrackingDomain": "string",
  "shouldHaveTrackingScript": true,
  "tags": [
    "string"
  ],
  "updatedTime": "2026-03-26T22:04:30.810Z",
  "url": "string",
  "workspace": {
    "id": "string"
  }
}
```

--------------------------------

### Example Invoice Collection Resource - JSON Response

Source: https://developers.voluum.com/

Example JSON structure for a successful response when retrieving a list of invoices.

```json
{
  "invoices": [
    {
      "id": "string",
      "dateOfIssue": "2026-03-20",
      "netAmount": 0,
      "grossAmount": 0
    }
  ],
  "totalCount": 0
}
```

--------------------------------

### GET /plan

Source: https://developers.voluum.com/

Retrieves a list of all available subscription plans.

```APIDOC
## GET /plan

### Description
Returns all available subscription plans for the user.

### Method
GET

### Endpoint
/plan

### Response
#### Success Response (200)
- **plans** (array) - List of available subscription plans.
```

--------------------------------

### Example Billing Notification Resource - JSON Response

Source: https://developers.voluum.com/

Example JSON structure for a successful response when retrieving billing notification status.

```json
{
  "notification": "TRAFFIC_CANCELLED",
  "owningPaymentProfile": true,
  "paymentDeadLine": "2026-03-20T15:03:28.045514103",
  "losingCustomDomains": true,
  "losingUserAccounts": true,
  "trialDaysLeft": 0,
  "balance": 0
}
```

--------------------------------

### Retrieve IP/UA Filtering Setup (GET /ip-filtering)

Source: https://developers.voluum.com/

This endpoint retrieves the current IP/UA filtering configuration. It allows you to view whether IP/UA rules are enabled and lists all configured rules, including IP ranges, request parameters, and user agent strings. This is useful for auditing or understanding existing filtering policies.

```json
{
  "enabled": true,
  "rules": [
    {
      "ipRules": [
        {
          "ipRangeEnd": "string",
          "ipRangeStart": "string"
        }
      ],
      "name": "string",
      "parameterValueRules": [
        {
          "parameter": "string",
          "value": "string"
        }
      ],
      "userAgentRules": [
        {
          "userAgent": "string"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /dictionary/os

Source: https://developers.voluum.com/

Retrieves a list of operating systems and their versions.

```APIDOC
## GET /dictionary/os

### Description
Retrieves a list of operating systems supported by the platform.

### Method
GET

### Endpoint
/dictionary/os

### Response
#### Success Response (200)
- **oses** (Array[Object]) - List of OS objects

#### Response Example
{
  "oses": [
    {
      "name": "string",
      "versions": ["string"]
    }
  ]
}
```

--------------------------------

### Get Workspaces (GET /multiuser/workspace)

Source: https://developers.voluum.com/

Retrieves a list of all workspaces available. The response includes details for each workspace, such as its ID, name, and associated memberships. The response structure follows the multiuser_WorkspaceCollectionResource model.

```json
{
  "workspaces": [
    {
      "id": "string",
      "memberships": [
        {
          "created": "2026-03-26T22:04:30.998Z",
          "email": "string",
          "firstName": "string",
          "lastName": "string",
          "permissions": [
            "invitationManagement"
          ],
          "restrictedColumns": [
            {
              "name": "string"
            }
          ],
          "role": "OWNER",
          "userId": "string",
          "workspaces": [
            {}
          ]
        }
      ],
      "name": "string"
    }
  ]
}
```

--------------------------------

### GET /bulk/offer

Source: https://developers.voluum.com/

Retrieves all offers as a CSV file.

```APIDOC
## GET /bulk/offer

### Description
Retrieves offers as a CSV file.

### Method
GET

### Endpoint
/bulk/offer

### Response
#### Success Response (200)
- **file** (binary) - CSV file containing offer data.
```

--------------------------------

### Voluum API Query Parameter Example

Source: https://developers.voluum.com/

This example shows how to append time-based query parameters to a request URL to filter data. Parameters are added after the question mark in the URL string.

```text
...?from=2017-02-20T00:00:00Z&to=2017-02-21T00:00:00Z&tz=Etc/GMT
```

--------------------------------

### GET /billing

Source: https://developers.voluum.com/

Retrieves the billing summary for the account.

```APIDOC
## GET /billing

### Description
Returns billing summary including status, current subscription, and statistics.

### Method
GET

### Endpoint
/billing

### Response
#### Success Response (200)
- Returns billing summary object.
```

--------------------------------

### GET /billing/plan

Source: https://developers.voluum.com/

Retrieves the details of the current subscription plan.

```APIDOC
## GET /billing/plan

### Description
Returns current subscription plan details.

### Method
GET

### Endpoint
/billing/plan

### Response
#### Success Response (200)
(Details of the subscription plan would be returned here)
```

--------------------------------

### Define Time and Localization Resources

Source: https://developers.voluum.com/

Example JSON structure for time-based and localization-based conditions.

```JSON
{
  "dictionary_time_TimeResource": {
    "hours": 14,
    "minutes": 30
  },
  "dictionary_country_CountryCodeResource": {
    "code": "US"
  },
  "dictionary_language_LanguageCodeResource": {
    "code": "en"
  }
}
```

--------------------------------

### GET /report

Source: https://developers.voluum.com/

Returns a standard report based on the provided parameters.

```APIDOC
## GET /report

### Description
Returns standard report data.

### Method
GET

### Endpoint
/report

### Response
#### Success Response (200)
- **columnMappings** (Array) - Column mappings
- **rows** (Array) - Report rows
- **offset** (integer) - Report rows page offset
- **limit** (integer) - Report rows page limit
- **totalRows** (integer) - Number of all report rows
- **totals** (Object) - Totals calculated from all report rows
- **truncated** (boolean) - Indicates if report was truncated
- **messages** (Array) - List of report messages

#### Response Example
{
  "columnMappings": [],
  "rows": [],
  "offset": 0,
  "limit": 0,
  "totalRows": 0,
  "totals": {},
  "truncated": true,
  "messages": []
}
```

--------------------------------

### GET /ip-filtering

Source: https://developers.voluum.com/

Retrieves the current IP/UA filtering setup, including enabled status and defined rules.

```APIDOC
## GET /ip-filtering

### Description
Retrieves IP/UA filtering setup. IP/UA Filtering permits you to add IP/UA rules based on IP / IP range and useragent values. Once IP/UA rules are enabled, they will be applied globally to all active campaigns with forbidden IP/UA traffic events excluded from your reporting.

### Method
GET

### Endpoint
/ip-filtering

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **enabled** (boolean) - Are IP/UA rules enabled?
- **rules** (Array[object], optional) - List of IP/UA rules
  - **name** (string) - Rule name
  - **ipRules** (Array[object], optional) - List of ip rules
    - **ipRangeStart** (string) - Ip range start (x.x.x.x)
    - **ipRangeEnd** (string) - Ip range end (x.x.x.x)
  - **userAgentRules** (Array[object], optional) - List of user agent rules
    - **userAgent** (string) - User agent string eg. "Mozilla/5.0 (Android 4.4; Mobile; rv:41.0) Gecko/41.0 Firefox/41.0"
  - **parameterValueRules** (Array[object], optional) - List of request parameters rules
    - **parameter** (string) - Query parameter name.
    - **value** (string) - Query parameter value.

#### Response Example
```json
{
  "enabled": true,
  "rules": [
    {
      "name": "string",
      "ipRules": [
        {
          "ipRangeStart": "string",
          "ipRangeEnd": "string"
        }
      ],
      "userAgentRules": [
        {
          "userAgent": "string"
        }
      ],
      "parameterValueRules": [
        {
          "parameter": "string",
          "value": "string"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Get Ad Spend Details (GET /billing/adspend)

Source: https://developers.voluum.com/

Retrieves ad spend details for a given period. It includes start and end times, total ad spend, and pricing information such as overage settings and included amounts. This endpoint is useful for monitoring advertising costs.

```json
{
  "startTime": "2026-03-20T15:03:28.134968842",
  "endTime": "2026-03-20T15:03:28.135079797",
  "adSpend": 0,
  "adSpendPricing": {
    "adSpendOveragesEnabled": true,
    "adSpendOveragesRate": 0,
    "includedAdSpend": 0
  }
}
```

--------------------------------

### POST /profile/mfa/initialize

Source: https://developers.voluum.com/

Initializes Multi-Factor Authentication (MFA) before activation.

```APIDOC
## POST /profile/mfa/initialize

### Description
Initializes MFA before activation.

### Method
POST

### Endpoint
/profile/mfa/initialize

### Parameters
#### Request Body
- **payload** (object) - Required - Password
  - **password** (string) - Required - User's password

### Request Example
```json
{
  "password": "string"
}
```

### Response
#### Success Response (200)
- **mfaSecret** (string) - MFA secret used to generate time-based one-time codes

#### Response Example
```json
{
  "mfaSecret": "string"
}
```
```

--------------------------------

### Retrieve Campaign URL via API

Source: https://developers.voluum.com/

Example of the response body for the GET /campaign/{campaignId}/url/{trafficSourceId} endpoint, which returns the generated URL for a specific campaign and traffic source.

```json
{
  "url": "string"
}
```

--------------------------------

### Create Offer Request (POST /offer)

Source: https://developers.voluum.com/

Example of how to create a new offer using a POST request to the /offer endpoint. This typically involves sending offer details in the request body.

```http
POST /offer
Content-Type: application/json

{
  "name": "Example Offer Name",
  "url": "http://example.com",
  "payout": {
    "type": "AUTO",
    "value": 1.50
  },
  "country": {
    "code": "US"
  },
  "workspace": {
    "id": "your_workspace_id"
  }
}
```

--------------------------------

### Get Traffic Source Templates (API)

Source: https://developers.voluum.com/

Retrieves a list of available traffic source templates. This endpoint returns a collection of traffic source template resources, detailing their features, supported tracking types, and integration information. It's useful for understanding available traffic sources for campaign setup.

```curl
curl -X GET "https://api.voluum.com/traffic-source-template" -H "Accept: application/json"
```

--------------------------------

### Get Browsers List

Source: https://developers.voluum.com/

Retrieves a list of available browsers and their supported versions. Dependencies: None. Inputs: None. Outputs: JSON object containing an array of browser resources, each with a name and a list of versions.

```json
{
  "browsers": [
    {
      "name": "string",
      "versions": [
        "string"
      ]
    }
  ]
}
```

--------------------------------

### PATCH /setup

Source: https://developers.voluum.com/

Updates the client setup configuration. This endpoint allows modification of various settings including domain configurations, anti-fraud settings, quotas, and routing options.

```APIDOC
## PATCH /setup

### Description
Updates client setup configuration. This endpoint allows for comprehensive modification of various Voluum settings, including domain management, anti-fraud configurations, quota limits, and real-time routing settings.

### Method
PATCH

### Endpoint
`/setup`

### Request Body
- **antiFraudConfiguration** (object) - Configuration for anti-fraud measures.
- **domains** (object) - Domain management settings.
  - **customDomains** (Array[object]) - List of custom domains.
    - **address** (string) - Required - Domain address.
    - **mainDomain** (boolean) - Required - Is it main domain?
    - **sslStatus** (string) - Required - SSL status for domain. Enum: ['ENABLED', 'PENDING', 'DISABLED'].
    - **workspaceIds** (Array[string]) - Optional - Workspace ids.
  - **dedicatedDomains** (Array[object]) - List of dedicated domains.
    - **address** (string) - Required - Domain address.
    - **mainDomain** (boolean) - Required - Is it main domain?
    - **sslStatus** (string) - Required - SSL status for domain. Enum: ['ENABLED', 'PENDING', 'DISABLED'].
    - **workspaceIds** (Array[string]) - Optional - Workspace ids.
  - **defaultRedirectDomain** (string) - Default redirect domain.
  - **internalDomains** (Array[object]) - List of internal domains.
    - **address** (string) - Required - Domain address.
    - **mainDomain** (boolean) - Required - Is it main domain?
    - **sslStatus** (string) - Required - SSL status for domain. Enum: ['ENABLED', 'PENDING', 'DISABLED'].
    - **workspaceIds** (Array[string]) - Optional - Workspace ids.
  - **redirectDomain** (string) - Redirect domain.
- **impressionPixelForwardingWhitelistedDomains** (Array[string]) - Whitelisted domains for impression pixel forwarding.
- **landerProtectionKey** (string) - Lander protection key.
- **quota** (object) - Quota limits for various features.
- **realtimeRoutingApi** (object) - Real-time routing API configuration.
  - **enabled** (boolean) - Indicates if real-time routing is enabled.
  - **url** (string) - URL for the real-time routing API.
- **rootRedirect** (object) - Root redirect configuration.
  - **enabled** (boolean) - Indicates if root redirect is enabled.
  - **url** (string) - URL for the root redirect.
- **timeToInstallConfiguration** (object) - Configuration for time to install.
- **urls** (object) - Various URL configurations.
  - **clickUrl** (string) - Click URL.
  - **multiOfferClickUrl** (string) - Multi-offer click URL.
  - **postbackUrl** (string) - Postback URL.
  - **securePostbackUrl** (string) - Secure postback URL.
  - **trackingPixelUrl** (string) - Tracking pixel URL.
  - **trackingScriptUrl** (string) - Tracking script URL.

### Request Example
```json
{
  "antiFraudConfiguration": {},
  "domains": {
    "customDomains": [
      {
        "address": "string",
        "mainDomain": true,
        "sslStatus": "ENABLED",
        "workspaceIds": [
          "string"
        ]
      }
    ],
    "dedicatedDomains": [
      {
        "address": "string",
        "mainDomain": true,
        "sslStatus": "ENABLED",
        "workspaceIds": [
          "string"
        ]
      }
    ],
    "defaultRedirectDomain": "string",
    "internalDomains": [
      {
        "address": "string",
        "mainDomain": true,
        "sslStatus": "ENABLED",
        "workspaceIds": [
          "string"
        ]
      }
    ],
    "redirectDomain": "string"
  },
  "impressionPixelForwardingWhitelistedDomains": [
    "string"
  ],
  "landerProtectionKey": "string",
  "quota": {
    "adminWorkerUserLimit": 0,
    "affiliateNetworks": 0,
    "asyncReportsRequests": 0,
    "autoRules": 0,
    "campaigns": 0,
    "campaignsInAllFromTrafficSourceAutoRule": 0,
    "columnConditionsPerAutoRule": 0,
    "customDomainCertificates": 0,
    "customDomains": 0,
    "dedicatedDomains": 0,
    "dimensionLists": 0,
    "entitiesPerAutoRule": 0,
    "flows": 0,
    "ipRangesPerCondition": 0,
    "ipUaEntriesPerRule": 0,
    "ipUaRules": 0,
    "landers": 0,
    "memberUserLimit": 0,
    "offers": 0,
    "sharedReports": 0,
    "trafficLogDailyRequests": 0,
    "trafficSources": 0,
    "valuesPerDimensionList": 0,
    "workspaces": 0
  },
  "realtimeRoutingApi": {
    "enabled": true,
    "url": "string"
  },
  "rootRedirect": {
    "enabled": true,
    "url": "string"
  },
  "timeToInstallConfiguration": {},
  "urls": {
    "clickUrl": "string",
    "multiOfferClickUrl": "string",
    "postbackUrl": "string",
    "securePostbackUrl": "string",
    "trackingPixelUrl": "string",
    "trackingScriptUrl": "string"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Client setup updated successfully."
}
```
```

--------------------------------

### POST /affiliate-network

Source: https://developers.voluum.com/

Creates a new affiliate network configuration.

```APIDOC
## POST /affiliate-network

### Description
Creates a new affiliate network entry in the system.

### Method
POST

### Endpoint
/affiliate-network

### Request Body
- **name** (string) - Required - Name of the affiliate network.
- **postbackUrl** (string) - Optional - The postback URL for tracking.

### Request Example
{
  "name": "New Network",
  "postbackUrl": "https://postback.example.com"
}

### Response
#### Success Response (200)
- **id** (string) - The ID of the created affiliate network.
```

--------------------------------

### Create Session Response Model

Source: https://developers.voluum.com/

Example JSON response returned after successfully creating a new session. It provides the token, expiration, and inaugural status.

```json
{
  "expirationTimestamp": "2026-03-26T22:04:30.887Z",
  "inaugural": true,
  "token": "string"
}
```

--------------------------------

### TrafficSourceResource JSON Schema Example

Source: https://developers.voluum.com/

An example JSON representation of the TrafficSourceResource object. This structure is used for API requests and responses when managing traffic source configurations.

```json
{
  "id": "string",
  "name": "string",
  "type": "CUSTOM",
  "postbackUrl": "https://example.com/postback",
  "customVariables": [
    {
      "index": 1,
      "name": "Campaign ID",
      "parameter": "cid",
      "placeholder": "{cid}",
      "trackedInReports": true
    }
  ],
  "createdTime": "2023-10-27T10:00:00Z",
  "deleted": false
}
```

--------------------------------

### POST /campaigns

Source: https://developers.voluum.com/

Create or update a campaign configuration including paths, targeting rules, and rotation settings.

```APIDOC
## POST /campaigns

### Description
Creates a new campaign or updates an existing one with specific routing paths, targeting predicates, and offer/lander weights.

### Method
POST

### Endpoint
/campaigns

### Parameters
#### Request Body
- **name** (string) - Required - Name of the campaign
- **paths** (array) - Required - List of path objects defining routing logic
- **targeting** (object) - Optional - Targeting predicates (deviceType, ip, isp, etc.)
- **defaultPaths** (array) - Required - Fallback paths for the campaign

### Request Example
{
  "name": "My Campaign",
  "paths": [{
    "name": "Main Path",
    "offers": [{"offer": {"id": "offer-123"}, "weight": 100}],
    "smartRotation": true
  }]
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created campaign

#### Response Example
{
  "id": "camp-abc-123"
}
```

--------------------------------

### Get Referrals List

Source: https://developers.voluum.com/

Retrieves a list of referrals with pagination and sorting options. Includes referral details and summary totals. Dependencies: None. Inputs: query parameters for pagination and sorting. Outputs: JSON object containing a list of referrals and their totals.

```json
{
  "referrals": [
    {
      "id": "string",
      "created": "2026-03-20T15:03:28.09588861",
      "state": "string",
      "lastLogin": "2026-03-20T15:03:28.096012553",
      "lastMonthCommissions": 0,
      "lifeTimeCommissions": 0
    }
  ],
  "totals": {
    "lastMonthCommissions": 0,
    "lifeTimeCommissions": 0,
    "count": 0
  }
}
```

--------------------------------

### Retrieve Affiliate Network Templates

Source: https://developers.voluum.com/

Returns a collection of available affiliate network templates. The response includes details such as description, documentation URL, and integration type.

```json
{
  "affiliateNetworkTemplates": [
    {
      "description": "string",
      "documentationUrl": "string",
      "id": "string",
      "image": "string",
      "integrationType": "string",
      "name": "string",
      "trusted": true,
      "websiteUrl": "string"
    }
  ]
}
```

--------------------------------

### Get Available Currencies

Source: https://developers.voluum.com/

Lists all available currencies supported by the system. Dependencies: None. Inputs: None. Outputs: An empty JSON object for a successful response, indicating a list is returned.

```json
{}
```

--------------------------------

### GET /dictionary/isp

Source: https://developers.voluum.com/

Retrieves a list of ISPs.

```APIDOC
## GET /dictionary/isp

### Description
Retrieves a list of Internet Service Providers (ISPs).

### Method
GET

### Endpoint
/dictionary/isp

### Query Parameters
- **query** (string) - Optional - Search filter for ISPs

### Response
#### Success Response (200)
- **isps** (Array[string]) - List of ISP names

#### Response Example
{
  "isps": [
    "string"
  ]
}
```

--------------------------------

### GET /domain/custom/validate

Source: https://developers.voluum.com/

Validates custom domains.

```APIDOC
## GET /domain/custom/validate

### Description
Validate custom domains.

### Method
GET

### Endpoint
/domain/custom/validate

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
No specific fields mentioned, likely a success status.

#### Response Example
None provided.
```

--------------------------------

### Get Brands List

Source: https://developers.voluum.com/

Retrieves a list of available brands, including their models. Dependencies: None. Inputs: None. Outputs: JSON object containing an array of brand resources, each with a name and a list of models.

```json
{
  "brands": [
    {
      "models": [
        "string"
      ],
      "name": "string"
    }
  ]
}
```

--------------------------------

### POST /campaign - Create Campaign

Source: https://developers.voluum.com/

Creates a new campaign with the specified settings.

```APIDOC
## POST /campaign

### Description
Creates a campaign.

### Method
POST

### Endpoint
/campaign

### Parameters
#### Header Parameters
- **If-Modified-Since** (date-time) - Optional - If the requested variant has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message-body.

#### Query Parameters
- **includeDeleted** (boolean) - Optional - Whether deleted entities should be included in the response.
- **fields** (Array[string]) - Optional - Names of the fields that should be included in the response.

### Request Body
- **autoOptimized** (boolean) - Optional - Indicates if the campaign is auto-optimized.
- **calculationMethod** (string) - Optional - The method used for calculation (e.g., "ROI").
- **id** (string) - Required - The unique identifier for the campaign.
- **landers** (Array) - Optional - A list of landers associated with the campaign.
  - **lander** (object) - Required - Details of the lander.
    - **id** (string) - Required - The ID of the lander.
  - **sublanders** (Array) - Optional - A list of sublanders.
  - **weight** (integer) - Optional - The weight assigned to this lander.
- **landersDisplaySortOrder** (string) - Optional - The display sort order for landers (e.g., "ASC").
- **listicle** (boolean) - Optional - Indicates if the campaign is a listicle.
- **name** (string) - Required - The name of the campaign.
- **offerRedirectMode** (string) - Optional - The redirect mode for offers (e.g., "REGULAR").
- **offers** (Array) - Optional - A list of offers associated with the campaign.
  - **offer** (object) - Required - Details of the offer.
    - **id** (string) - Required - The ID of the offer.
  - **weight** (integer) - Optional - The weight assigned to this offer.
- **offersDisplaySortOrder** (string) - Optional - The display sort order for offers (e.g., "ASC").
- **realtimeRoutingApiState** (string) - Optional - The state of the real-time routing API (e.g., "DISABLED").
- **smartRotation** (boolean) - Optional - Indicates if smart rotation is enabled.
- **weight** (integer) - Optional - The weight of the campaign.
- **defaultPathsSmartRotation** (boolean) - Optional - Indicates if default paths use smart rotation.
- **deleted** (boolean) - Optional - Indicates if the campaign is deleted.
- **note** (object) - Optional - Additional notes for the campaign.
  - **note** (string) - Optional - The content of the note.
- **realtimeRoutingApi** (string) - Optional - The state of the real-time routing API.
- **updatedTime** (string) - Optional - The timestamp when the campaign was last updated.
- **workspace** (object) - Optional - Workspace details.
  - **id** (string) - Required - The ID of the workspace.
- **listicle** (object) - Optional - Listicle specific settings.
  - **destination** (object) - Optional - Destination details for the listicle.
    - **lander** (object) - Optional - Lander details.
      - **id** (string) - Required - The ID of the lander.
    - **offers** (Array) - Optional - List of offers.
      - **id** (string) - Required - The ID of the offer.
    - **sublanders** (Array) - Optional - List of sublanders.
  - **id** (string) - Required - The ID of the listicle.
  - **name** (string) - Required - The name of the listicle.
  - **offerRedirectMode** (string) - Optional - The redirect mode for offers.
- **redirectUrl** (object) - Optional - Redirect URL settings.
  - **redirectMode** (string) - Optional - The redirect mode.
  - **url** (string) - Required - The URL for redirection.
- **tags** (Array[string]) - Optional - Tags associated with the campaign.
- **trafficSource** (object) - Optional - Traffic source details.
  - **id** (string) - Required - The ID of the traffic source.
- **trafficType** (string) - Optional - The type of traffic (e.g., "POP").
- **url** (string) - Required - The URL for the campaign.

### Request Example
```json
{
  "autoOptimized": true,
  "calculationMethod": "ROI",
  "id": "string",
  "landers": [
    {
      "lander": {
        "id": "string"
      },
      "sublanders": [
        {}
      ],
      "weight": 0
    }
  ],
  "landersDisplaySortOrder": "ASC",
  "listicle": true,
  "name": "string",
  "offerRedirectMode": "REGULAR",
  "offers": [
    {
      "offer": {
        "id": "string"
      },
      "weight": 0
    }
  ],
  "offersDisplaySortOrder": "ASC",
  "realtimeRoutingApiState": "DISABLED",
  "smartRotation": true,
  "weight": 0
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created campaign.
- **name** (string) - The name of the created campaign.
- **url** (string) - The URL associated with the campaign.

#### Response Example
```json
{
  "id": "campaign-123",
  "name": "Example Campaign",
  "url": "http://example.com"
}
```
```

--------------------------------

### Get Billing Information (GET /billing/info)

Source: https://developers.voluum.com/

Retrieves the current billing information for the account. This includes the billing address, company name, payment status, and tax ID. This data is essential for managing account settings and ensuring accurate billing.

```json
{
  "address": {
    "addressLine": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "zipCode": "string"
  },
  "name": "string",
  "paymentEnabledStatus": "ENABLED",
  "taxId": "string"
}
```

--------------------------------

### GET /paths

Source: https://developers.voluum.com/

Retrieves details about path configurations, including landers, offers, and auto-optimization settings.

```APIDOC
## GET /paths

### Description
Fetches the configuration for a specific path, defining how traffic is distributed between landers and offers.

### Method
GET

### Endpoint
/paths/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the path.

### Response
#### Success Response (200)
- **id** (string) - Path ID
- **active** (boolean) - Is the path active
- **autoOptimizationMode** (string) - Optimization mode (OFFER, LANDER, INDEPENDENT, DEPENDENT)
- **offers** (Array) - List of offers associated with the path

#### Response Example
{
  "id": "path-456",
  "active": true,
  "autoOptimizationMode": "OFFER"
}
```

--------------------------------

### GET /report/async/scheduled/list

Source: https://developers.voluum.com/

Lists all currently scheduled reports.

```APIDOC
## GET /report/async/scheduled/list

### Description
Lists scheduled reports.

### Method
GET

### Endpoint
/report/async/scheduled/list

### Response
#### Success Response (200)
- **list** (Array) - List of scheduled reports
```