AppResellerOpportunities

Create opportunity

Changed on Nov 6, 2026

Creates a new opportunity

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

post/assistedSales/v1/opportunities

Request

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

Query parameters

context'RESELLER' | 'SSR'

Deprecated. Parameter has no impact on this endpoint.

Request body

customerCompanyIdstring required

Customer company ID

customerIdstring required

Customer user ID

ownerCompanyIdstring required

Sales agent company ID

ownerIdstring required

Sales agent user ID

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

The currency using the ISO-4217 currency code

purchaseEffectiveDatenumber

Opportunity purchase effective date, in UNIX Epoch milliseconds

namestring

Opportunity name

createdByCompanyIdstring

Created by company ID

createdByIdstring

Created by user ID

purchaseCustomAttributesobject

Custom attributes related to the purchase

Example request

{
  "customerCompanyId": "498c62ea-ad14-48e6-96ce-5400c617444c",
  "customerId": "505f0a0c-57a7-4d9e-9fac-66bbf557ac4d",
  "ownerCompanyId": "6a62244e-aa2f-461b-8c7a-3a0e091be9d3",
  "ownerId": "d781ac09-b4fe-4d57-8ba2-4640fc5b7c49",
  "items": [
    {
      "pricingPlanId": "85d30404-c56b-4dff-9f3b-06636477fe55",
      "units": [
        {
          "quantity": 10,
          "unit": "USER"
        }
      ]
    },
    {
      "pricingPlanId": "d12931cf-eac6-45fa-8965-d33b1c5698b0",
      "units": []
    }
  ],
  "currency": "USD",
  "createdByCompanyId": "b7e0c48b-6d0d-45fc-9c8a-3fa3fd84d9f1",
  "createdById": "8f6b3d29-4169-4fb0-91ff-bad9b7a3d0d4",
  "purchaseCustomAttributes": {
    "paid_off_platform_contact": [
      "janet.doe@accounting.acme.com"
    ]
  }
}

Response

Opportunity created

idstring

Opportunity ID

createdOnnumber

Opportunity creation date, in UNIX Epoch milliseconds

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

The currency using the ISO-4217 currency code

purchaseEffectiveDatenumber

Opportunity purchase effective date, in UNIX Epoch milliseconds

namestring

Opportunity name

status'OPEN' | 'CLOSED' | 'PENDING_REVIEW'

Opportunity status

purchaseIdstring

Purchase ID

purchaseNumberstring

Purchase number

availableActionsAvailableAction[]

Available actions on the opportunity

purchaseCustomAttributesobject

Custom attributes related to the purchase

Example response

{
  "id": "ef6c414f-39da-401f-a4b8-81adc6190fda",
  "ownerUser": {
    "id": "d781ac09-b4fe-4d57-8ba2-4640fc5b7c49",
    "email": "john.doe@acme.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": {
      "id": "1",
      "name": "Acme Corp.",
      "isReseller": true
    }
  },
  "customerUser": {
    "id": "498c62ea-ad14-48e6-96ce-5400c617444c",
    "email": "ubrownfield@stark.com",
    "firstName": "Ulysses",
    "lastName": "Brownfield",
    "company": {
      "id": "100",
      "name": "Customer Company",
      "isReseller": false
    }
  },
  "createdOn": "1546300800000",
  "currency": "USD",
  "purchaseEffectiveDate": "1577750400000",
  "name": "Jarvis Iniative",
  "status": "OPEN",
  "items": [
    {
      "id": "4ccf689b-4339-4fc9-a8b3-b05c5a87c1be",
      "pricingPlanId": "4bc864b5-f63f-4933-be19-3700aa9a8cc4",
      "units": [
        {
          "quantity": "20",
          "unit": "USER"
        }
      ],
      "subscriptionCustomAttributes": {
        "intended_os": [
          "other",
          "ios",
          "macos"
        ],
        "sales_agent_id": [
          "R353113R"
        ]
      },
      "vendorRequiredFields": {
        "name": [
          "jonh"
        ],
        "lastname": [
          "doe"
        ],
        "email": [
          "john.doe@acme.com"
        ]
      }
    },
    {
      "id": "dece524d-0466-4185-b3bb-1f8a300c37cd",
      "pricingPlanId": "80b85538-ffc1-4c4b-acb1-1bf87c8c2fc4",
      "units": []
    }
  ],
  "availableActions": [
    "EDIT",
    "FINALIZE",
    "SUBMIT_FOR_REVIEW",
    "ADD_PRODUCT",
    "SET_CUSTOM_PRICE",
    "SET_CUSTOM_CONTRACT",
    "SET_PROVISIONING_DATE",
    "SET_BILLING_DATE",
    "SET_COMMISSION_RATE",
    "CHANGE_OPPORTUNITY_OWNER"
  ],
  "actionRestrictions": {}
}

Changes

Nov 6, 20261fc240f06971 Revision changes
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- 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
- 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 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

Operation history