Answer5

AppResellerAccount6

AppResellerAssignment3

AppResellerCatalog2

AppResellerCompanyAssociation3

AppResellerLeads11

AppResellerOpportunities23

AppResellerOrder1

AppResellerPaymentMethod3

AppResellerQuoteVersion4

AppResellerReconciliation3

AppResellerSubscription5

Bundle3

checkoutItemDetails1

Comment5

Companies7

CompanyMemberships15

CurrencyExchangeRate4

CustomerNotification9

DataUploader3

DefaultNotificationTemplateApi5

Discount5

Domains3

Edition1

Event2

Group10

InboundEvents1

Integration4

Invitation5

Invoice7

Marketplace Product Settings5

MyApps4

Navigation1

Payment5

Payment Methods7

PaymentInstrument6

PaymentPlan3

Payments v29

Product8

Product Management API4

ProductContext2

PurchaseOrder7

Question4

Reconciliation1

Reporting3

Reporting V22

Review5

Search1

SegmentFolders15

Settings2

ShoppingCart28

SubscriptionAssignments5

Subscriptions23

Sync5

User13

UserAccounts2

AppResellerLeads

Create lead

Changed on Nov 6, 2026

Creates a manual, company profile or product profile lead. Manual leads are visible to only those who created them. Company profile leads are visible to the Reseller that created the profile page as well as the Reseller Managers and Marketplace Managers. Product profile leads are visible to Marketplace Managers and Reseller Managers and can be configured so that the Developers who own the product profile can also see them. Required parameters: Company name Contact email Lead type Partner If the lead type is PRODUCT, the product ID If the lead type is COMPANY, the reseller company ID The required parameter correspond to the request payload in LeadCreationRequest

post/lead/v2/leads

Request

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

Query parameters

The supported lead's API contexts. ANONYMOUS context can be used to create a PRODUCT or COMPANY lead without authentication.

companyIdstring required

Company ID of the user who is creating the lead. Only required when creating a lead of type MANUAL.

userIdstring required

User ID of the user who is creating the lead. Only required when using OAuth credentials with role PARTNER to create a lead of type MANUAL. In this case, the user ID must correspond to a marketplace user who has the Marketplace Manager role. The user must be a member of a company that has marketplace access.

Request body

partnerstring required

Marketplace partner code

leadType'MANUAL' | 'PRODUCT' | 'COMPANY' required

The type of lead. Leads created manually by users have the MANUAL type. Leads created by anonymous users through profiles have the PRODUCT or COMPANY types, depending on whether they were created from product profiles or reseller company profiles respectively.

customAttributesobject

Custom attributes associated with the lead. This is a key-value object where the values are a set of strings associated with a given key, which is also a String.

notesstring

Notes attached to the lead

Example request

{
  "customer": {
    "company": {
      "street1": "1234 Main St",
      "street2": "30th Floor, Apt B",
      "city": "Miami",
      "country": "US",
      "state": "FL",
      "zip": "33033",
      "name": "Acme"
    },
    "contact": {
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+13055555555",
      "email": "john.doe@acme.com"
    }
  },
  "leadType": "MANUAL",
  "partner": "APPDIRECT"
}

Response

Lead created

idstring required

Lead ID

partnerstring required

Marketplace partner code

leadType'MANUAL' | 'PRODUCT' | 'COMPANY' required

The lead status. PENDING_FOR_MANAGERS requires SUBMITTED and PENDING_CONVERSION_APPROVAL; ACCEPTED_FOR_MANAGERS requires ASSIGNED, CONVERSION_APPROVED, CONVERTED, DELETED, DISQUALIFIED and LEGACY.

createdOnnumber required

The date on which the lead was created, in UNIX Epoch milliseconds

lastModifiednumber required

The date on which the lead was last modified, in UNIX Epoch milliseconds

customAttributesobject

Custom attributes associated with the lead

notesstring

Notes attached to the lead

result'OPEN' | 'LOST' | 'WON'

Additional status information about CONVERTED leads

Example response

{
  "customer": {
    "customer": {
      "company": {
        "name": "Acme",
        "street1": "1234 Main St",
        "street2": "Suite 100",
        "city": "Beverly Hills",
        "state": "CA",
        "zip": "90210",
        "country": "US",
        "size": "RANGE_1_9"
      },
      "contact": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@acme.com",
        "phone": "+14455555555"
      }
    }
  },
  "referrer": {
    "participantType": "CHANNEL",
    "partner": "APPDIRECT"
  },
  "recipient": {
    "participantType": "CHANNEL",
    "partner": "APPDIRECT"
  },
  "reseller": {
    "companyId": "386626c0-53e2-4515-ffff-4a720bb5d029",
    "companyName": "Reseller Company",
    "id": "01d75b7c-ea78-ffff-9e58-6ad217bddcbd",
    "role": "RESELLER"
  },
  "creator": {
    "companyId": "386626c0-53e2-4515-ffff-4a720bb5d029",
    "companyName": "Reseller Company",
    "id": "01d75b7c-ea78-ffff-9e58-6ad217bddcbd",
    "role": "RESELLER"
  },
  "convertedUser": {
    "companyId": "386626c0-53e2-4515-ffff-4a720bb5d029",
    "companyName": "Reseller Company",
    "id": "01d75b7c-ea78-ffff-9e58-6ad217bddcbd",
    "role": "RESELLER"
  },
  "convertedCompany": {
    "id": "386626c0-53e2-4515-ffff-4a720bb5d029",
    "name": "Reseller Company"
  },
  "profileCompany": {
    "id": "386626c0-53e2-4515-ffff-4a720bb5d029",
    "name": "Reseller Company"
  },
  "profileProduct": {
    "id": "009fd909-aaaa-4e37-bbad-701f87724bca",
    "name": "Appsome Product",
    "provider": "APPDIRECT"
  },
  "profileProductEdition": {
    "id": "d4610cd4-09d5-abcd-a769-a47666a1c311",
    "name": "Enterprise Edition"
  }
}

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
  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
- 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 enum value CHANNEL_ADMIN to the query request parameter context
- 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