AlphaAlpha Docs

Qualify a lead

Qualifies a lead and creates a customer and opportunity

POST
/crm/leads/{id}/qualify
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/leads/string/qualify" \  -H "Content-Type: application/json" \  -d '{    "createFollowUpActivity": true,    "opportunityName": "string"  }'
{
  "customerId": "string",
  "lead": {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customer": {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    },
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "hasAcceptedQuote": true,
    "id": "string",
    "industry": "string",
    "instagramHandle": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "note": "string",
    "opportunity": {
      "id": "string",
      "name": "string",
      "value": 0.1
    },
    "opportunityId": "string",
    "owner": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "preferredLanguage": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedByUser": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiary": {
      "color": "string",
      "id": "string",
      "name": "string"
    },
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "string"
  },
  "opportunityId": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}