Skip to content
/Product Plans

Product Plans

Set up - Tenancy - Product Plans

Operations

Copy an existing Product Plan

Request

Create a new Product Plan as a copy of an existing ACTIVE Product Plan accessible to the user. The new Product Plan inherits country prices, durations, and other fields from the source. The caller chooses a subset of features and automationDirectories — both must be subsets of the source's. The new Product Plan is created in ACTIVE status. Child Sales Partners are allowed to copy their own Product Plans. If the target Sales Partner has no active default Product Plan, the copy is automatically set as the default.

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

Copy parameters

productPlanIdinteger, (int64)required

Id of the existing ACTIVE Product Plan to copy from

namestringrequired

Name of the new Product Plan

descriptionstring

Description of the new Product Plan

featuresArray of strings, non-empty

Features for the new Product Plan. Must be a non-empty subset of the source Product Plan features.

Items Enum:"ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES""APPLE_POSTING""APPLE_POSTING_WRITE"
automationDirectoriesArray of strings, non-empty

Automation directories for the new Product Plan. Must be a non-empty subset of the source Product Plan automationDirectories.

Items Enum:"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP_API""MEINESTADT""NOKIA_HERE""FACEBOOK""TOMTOM"
salesPartnerIdinteger, (int64)

Optional. Sales Partner id to own the new Product Plan. Defaults to the calling user's Sales Partner. If provided, must be the caller's Sales Partner or one of its child Sales Partners.

curl -i -X POST \
  https://uberall.com/api/product-plans/copy \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "productPlanId": 0,
    "name": "string",
    "description": "string",
    "features": [
      "ADS"
    ],
    "automationDirectories": [
      "FOURSQUARE"
    ],
    "salesPartnerId": 0
  }'

Responses

Product Plan successfully copied

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "productPlanResponse": {
      "id": 0,
      "name": "string",
      "salesPartnerId": 0,
      "features": [
        "ADS"
      ],
      "updatedDirectories": [
        "FOURSQUARE"
      ],
      "countryPrice": [
        {
          "country": "AF",
          "price": 0,
          "marketDevelopmentFunds": 0,
          "priceSetup": 0
        }
      ],
      "currency": "string",
      "defaultPlan": true,
      "identifier": "string",
      "description": "string",
      "dateCreated": "2019-08-24T14:15:22Z",
      "lastUpdated": "2019-08-24T14:15:22Z",
      "duration": 0,
      "initialDuration": 0,
      "billingPeriod": 0,
      "initialBillingPeriod": 0,
      "defaultPrice": 0,
      "defaultOriginalPrice": 0,
      "defaultPriceSetup": 0,
      "defaultMarketDevelopmentFunds": 0,
      "status": "ACTIVE"
    }
  }
}