v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Lead

Adds a new lead. A new non-loyalty customer will be created if you pass a new customer identifier.

patch/leads

Headers

languagestring

Specify the ISO code of a language to get extended field values in your preferred language. For example, zh for Chinese, id for Indonesian, ar for Arabic. English is the default language.

Response

200

idinteger
userIdinteger
typestring
leadForstring
statusstring
nextFollowUpstring
createdOnstring
createdByinteger
lastUpdatedOnstring
lastUpdatedByinteger
orgSourceIdinteger

Example response

{
  "id": 1,
  "userId": 368754334,
  "type": "SKU",
  "leadFor": "item001",
  "status": "ON_HOLD",
  "nextFollowUp": "2018-10-05T08:00:00+05:30",
  "createdOn": "2018-10-04T13:30:00+05:30",
  "createdBy": 28812689,
  "lastUpdatedOn": "2018-11-14T15:38:04+05:30",
  "lastUpdatedBy": 15002926,
  "followUpDetails": [
    {
      "id": 1,
      "userId": 368754334,
      "leadId": 1,
      "notes": "notes 1",
      "createdBy": 15002926,
      "createdOn": "2018-11-14T15:38:04+05:30",
      "followedUpBy": 28812689,
      "followedUpOn": "2018-10-04T12:45:00+05:30",
      "scheduledFollowUp": "2018-10-04T12:30:00+05:30"
    }
  ],
  "extendedFields": {
    "trial_status": "Not Done"
  },
  "statusLogDetails": [
    {
      "id": 1,
      "userId": 368754334,
      "leadId": 1,
      "status": "OPEN",
      "createdBy": 15002926,
      "createdOn": "2018-11-14T15:38:04+05:30",
      "reasonId": 5,
      "reason": "Best price available at another store"
    }
  ],
  "orgSourceId": -1
}