Skip to main content

Collect and Qualify Leads

A lead is an unqualified sales opportunity. A lead can be a company or an individual who has expressed interest in a company's product and/or service. In FowCRM, a lead is the starting point of a person's record.

Create a Lead​

The v2 Lead AddLead endpoint should be used for lead integration. For detailed documentation, visit Lead.

Request Payload

{
  "data": {
    "firstName": "John",
    "lastName": "Doe",
    "phone": "905525220174",
    "email": "johndoesample@gmail.com",
    "date": "2022-09-30T13:24:00.000Z",
    "department": "Development",
    "title": "Developer",
    "sourceId": "b48e08b5-05d7-4f8e-82d3-ac8f079eb2c9",
    "statusId": "7a12f534-4ff6-4aac-827c-c9816b0a5cef",
    "description": "<p>Lorem ipsum</p>"
  },
  "customFields": {
    "customFieldString1": "Backend Developer"
  }
}

The sourceId and statusId parameters are treated as tags. Therefore, this information is obtained using the Get Lead Source and Get Lead Status endpoints.

Response

{
  "success": true,
  "items": "1e54284f-fbfe-48b3-bd9f-a9fd1b547d51"
}

Note These fields are not required.

Lead Convert​

Lead conversion is a joint marketing and sales process that involves converting leads into customers through nurturing tactics like behavior automation, retargeting, and email nurturing.

Request Payload

{
  "leadId": "b9343323-7716-40dd-83c1-d2d7e7c71bf8",
  "contactId": "",
  "addOpportunity": true,
  "title": "John Doe's Opportunity",
  "pipelineId": "dcf2018a-569b-4f7e-b5b6-c670096a8feb",
  "pipelineStepId": "2401a9a7-8704-4e16-b4fd-a4afcb0277e2",
  "estimatedAmount": 110,
  "estimatedCloseDate": "2022-09-30T13:33:00.000Z",
  "opportunityProducts": [
    {
      "productId": "c9608ca3-3c51-4804-84f6-60953b92608a",
      "quantity": 1
    }
  ],
  "description": "<p>First opportunity</p>",
  "customFieldString1": "Critical",
  "currencyId": "1aa008ba-2ba9-49b2-804b-d7e4b4d2d09a",
  "newAccount": false,
  "existingAccount": false,
  "newContact": true,
  "existingContact": false
}

During the conversion process, a new contact record or a new account record can be created optionally.

The example request payload above represents the opening of a new contact record. It also includes adding an opportunity to this newly opened contact record.

If adding Opportunity is not desired, the addOpportunity field should be marked as false.

The pipelineId and pipelineStepId parameters are predefined lists. To use these lists, endpoint Pipeline & Pipeline Step should be used.

An example pipeline response object;

{
  "success": true,
  "items": {
    "totalCount": 1,
    "items": [
      {
        "id": "dcf2018a-569b-4f7e-b5b6-c670096a8feb",
        "name": "Default",
        "ownerId": 158,
        "periodId": "a112006b-0cd9-0608-2439-bf31d69ae7ab",
        "ownerGroupId": "a2c5cfaf-13b5-4194-b3f3-2fe7f385a7d4",
        "pipelineSteps": [],
        "authorizeLevel": "Public",
        "authorizeIds": [
          "158",
          "a2c5cfaf-13b5-4194-b3f3-2fe7f385a7d4"
        ]
      }
    ]
  }
}

When a new opportunity is wanted to be created, product information becomes mandatory.

Products are predefined lists within the system. To use the Product module, the Product endpoint must be used.

Example product response object;

{
  "success": true,
  "items": {
    "totalCount": 1,
    "items": [
      {
        "uniqueNumber": "577948",
        "id": "c9608ca3-3c51-4804-84f6-60953b92608a",
        "code": "SKFB54",
        "name": "Skoda Fabia",
        "description": "<p>Skoda Fabia 110 hp</p>",
        "categories": [],
        "periodId": "cc4ec2a5-4753-4379-bcec-ec1adfbb9540",
        "period": {
          "name": "2021-2022",
          "startDate": "2021-01-01T00:00:00Z",
          "endDate": "2024-12-31T00:00:00Z",
          "modelId": "00000000-0000-0000-0000-000000000000",
          "isChangedLastModificationTime": false,
          "isChangedLastModifierUserId": false,
          "creatorUserId": 158,
          "creationTime": "2021-10-07T07:43:22.319Z",
          "isDeleted": false,
          "lastModifierUserId": 158,
          "lastModificationTime": "2021-12-27T12:31:14.998Z",
          "isRunAutomation": true,
          "isRunHandlers": true,
          "id": "cc4ec2a5-4753-4379-bcec-ec1adfbb9540"
        },
        "unitPrice": 110,
        "taxPercent": 2,
        "isIncludedTax": true,
        "creationTime": "2022-09-12T11:12:44.602Z",
        "lastModificationTime": "2022-09-12T11:12:44.602Z",
        "creatorUserId": 158,
        "lastModifierUserId": 158,
        "currencyId": "1aa008ba-2ba9-49b2-804b-d7e4b4d2d09a",
        "exchangeRate": 0,
        "isFixed": false,
        "stockCode": "SKFB54",
        "cost": 100,
        "invoiceFrequency": "None",
        "labels": [],
        "creationUser": {
          "userName": "furkan.gungor",
          "name": "Furkan",
          "surname": "Güngör",
          "emailAddress": "furkan.gungor@bilgeadam.com",
          "isActive": true,
          "fullName": "Furkan Güngör",
          "creationTime": "2021-10-07T07:43:00.373Z",
          "tenantId": 93,
          "isAuthorizeDisable": false,
          "id": 158
        },
        "lastModificationUser": {
          "userName": "furkan.gungor",
          "name": "Furkan",
          "surname": "Güngör",
          "emailAddress": "furkan.gungor@bilgeadam.com",
          "isActive": true,
          "fullName": "Furkan Güngör",
          "creationTime": "2021-10-07T07:43:00.373Z",
          "tenantId": 93,
          "isAuthorizeDisable": false,
          "id": 158
        },
        "currency": {
          "name": "Turkish lira",
          "code": "TRY",
          "symbol": "₺",
          "modelId": "00000000-0000-0000-0000-000000000000",
          "isChangedLastModificationTime": false,
          "isChangedLastModifierUserId": false,
          "creatorUserId": 1,
          "creationTime": "2020-11-27T09:25:58.467Z",
          "isDeleted": false,
          "isRunAutomation": true,
          "isRunHandlers": true,
          "id": "1aa008ba-2ba9-49b2-804b-d7e4b4d2d09a"
        }
      }
    ]
  }
}

currencyId must be any of the predefined currency list. currency information is required.