AppResellerOpportunities

Edit item

Changed on Nov 6, 2026

Edit an item on the opportunity.

Required: Accept-Language header with Locale format. For example: en-US

put/assistedSales/v1/opportunities/{opportunityId}/items/{itemId}

Request

Base URL
https://marketplace.appdirect.com/api
Auth
none declared
TypeScript
https://skmtc.dev/appdirect/apis/companies/docs/assistedSales/v1/opportunities/:opportunityId/items/:itemId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

opportunityIdstring required

Opportunity ID

itemIdstring required

Item ID

Request body

idstring

Item ID

pricingPlanIdstring required

Pricing plan ID

subscriptionCustomAttributesCustomAttribute

Custom attributes as key-value pairs. Values must be a string array

vendorRequiredFieldsCustomAttribute

Custom attributes as key-value pairs. Values must be a string array

Example request

{
  "id": "37f56046-2cec-4bf4-a4e2-5a733dc849a9",
  "pricingPlanId": "a22c03e9-9e27-4e85-8433-78f246345685",
  "units": [
    {
      "quantity": "8",
      "unit": "USER"
    }
  ],
  "customPrices": [
    {
      "costId": "e5f403a3-7ba0-45d4-8117-8dd8cbceb6c6",
      "price": 100
    },
    {
      "costId": "9742e09a-e1b4-4b9e-b1a7-66df3e41cebe",
      "price": 20
    }
  ],
  "contractConfiguration": {
    "minimumServiceLength": "3",
    "minimumServiceLengthUnit": "MONTHLY",
    "terminationFee": {
      "feeType": "FIXED",
      "amount": "2"
    },
    "renewalConfiguration": "MONTH_TO_MONTH",
    "terminationFeeGracePeriod": "7",
    "terminationFeeGracePeriodUnit": "DAY",
    "contractCancellationPeriodLimit": null,
    "contractCancellationPeriodUnit": "NONE",
    "endOfContractGracePeriod": null,
    "endOfContractGracePeriodUnit": "INFINITY",
    "unitTerms": {
      "USER": {
        "blockContractIncrease": false,
        "blockOriginalContractDecrease": false,
        "blockContractDecrease": true
      }
    },
    "blockContractUpgrades": false,
    "blockContractDowngrades": true,
    "blockSwitchToShorterContract": true,
    "keepContractDateOnPlanChange": false
  },
  "provisioningConfiguration": {
    "date": "1546300800000",
    "strategy": "CUSTOM"
  },
  "billingConfiguration": {
    "date": "1546300800000",
    "strategy": "CUSTOM"
  },
  "subscriptionCustomAttributes": {
    "intended_os": [
      "other",
      "ios",
      "macos"
    ],
    "sales_agent_id": [
      "R353113R"
    ]
  },
  "vendorRequiredFields": {
    "name": [
      "John"
    ],
    "lastname": [
      "Doe"
    ],
    "email": [
      "john.doe@acme.com"
    ]
  }
}

Response

Success

idstring

Item ID

subscriptionCustomAttributesobject

Custom attributes related to the subscription

vendorRequiredFieldsobject

Custom attributes related to vendor required fields for the subscription

Example response

{
  "id": "37f56046-2cec-4bf4-a4e2-5a733dc849a9",
  "product": {
    "id": "cc0c7c28-ea65-4bab-8a4a-5e84d90ab291",
    "name": "Appsome Webapp",
    "type": "WEB_APP",
    "logo": "https://logs.acme.com/400x400/ddd/000.png&text=Appsome+App"
  },
  "pricingPlan": {
    "id": "031d9ed2-3df1-44f5-876a-6b4318ba7bdb",
    "name": "Recurring Edition with Unlimited Included Users"
  },
  "units": [
    {
      "quantity": "8",
      "unit": "USER"
    }
  ],
  "pricing": [
    {
      "costTypeCategory": "RECURRING",
      "costType": "RECURRING_FLAT",
      "pricingStrategy": "FREE",
      "priceRanges": [],
      "description": "RECURRING_FLAT",
      "quantity": "1.0000000000",
      "salePrice": "14.9500000000",
      "wholesalePrice": "12.0000000000",
      "totalSalePrice": "14.9500000000"
    },
    {
      "costTypeCategory": "RECURRING",
      "costType": "INCLUDED",
      "pricingStrategy": "UNLIMITED",
      "priceRanges": [],
      "description": "INCLUDED",
      "unit": "USER",
      "salePrice": "0.0000000000",
      "wholesalePrice": "0.0000000000",
      "totalSalePrice": "0.0000000000"
    }
  ],
  "subscriptionCustomAttributes": {
    "intended_os": [
      "other",
      "ios",
      "macos"
    ],
    "sales_agent_id": [
      "R353113R"
    ]
  },
  "vendorRequiredFields": {
    "name": [
      "jonh"
    ],
    "lastname": [
      "doe"
    ],
    "email": [
      "john.doe@acme.com"
    ]
  },
  "contractConfiguration": {
    "minimumServiceLength": "3",
    "minimumServiceLengthUnit": "MONTHLY",
    "terminationFee": {
      "feeType": "FIXED",
      "amount": "2"
    },
    "renewalConfiguration": "MONTH_TO_MONTH",
    "terminationFeeGracePeriod": "7",
    "terminationFeeGracePeriodUnit": "DAY",
    "contractCancellationPeriodLimit": null,
    "contractCancellationPeriodUnit": "NONE",
    "endOfContractGracePeriod": null,
    "endOfContractGracePeriodUnit": "INFINITY",
    "unitTerms": {
      "USER": {
        "blockContractIncrease": false,
        "blockOriginalContractDecrease": false,
        "blockContractDecrease": true
      }
    },
    "blockContractUpgrades": false,
    "blockContractDowngrades": true,
    "blockSwitchToShorterContract": true,
    "keepContractDateOnPlanChange": false
  },
  "billingConfiguration": {
    "date": "1546300800000",
    "strategy": "CUSTOM"
  },
  "provisioningConfiguration": {
    "date": "1546300800000",
    "strategy": "CUSTOM"
  }
}

Changes

Nov 6, 20261fc240f06971 Revision changes
- breaking
  added the new required request property
- breaking
  the request's body type changed from no type to object
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history

Edit item

Request

Path parameters

Request body

Example request

Response 200OK

Example response

Changes

Response