APappdirect
AppResellerLeads

Assign lead

Changed on

Assigns a lead to a Reseller company. The assignee will be able to see that lead as long as is not assigned to another company. The owner of the lead retains visibility even if it is assigned to another company.

post/lead/v2/assignment

Request

Query parameters

context'RESELLER' | 'REFERRAL' | 'DEVELOPER' | 'RESELLER_MANAGER' | 'PARTNER' | 'ANONYMOUS' | 'CHANNEL_ADMIN' required

Supported contexts

companyIdstring required

Company ID of the user who is assigning the lead

Request body

leadIdstring required

Lead ID

Example request

{
  "leadId": "29a1dc26-8088-475c-ba75-7b73915a0fab",
  "recipient": {
    "participantType": "COMPANY",
    "companyId": "386626c0-1234-4515-8450-4a720bb5d029"
  }
}

Response

Lead assigned

Example response

{
  "lead": {
    "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

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

    • info

      added the required property to the response with the status