v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Lead

Updates extended fields for an existing lead

put/leads/{leadId}

Path parameters

leadIdinteger required

Unique ID of the lead.

Query parameters

extendedFieldsobject

Key-value pairs of extended fields and its values

ownerstring

Username of the owner or associate of the lead. Use this to assign leads to a associate.

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": 19,
  "userId": 316804150,
  "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-28T10:31:19+05:30",
  "lastUpdatedBy": 15147364,
  "followUpDetails": [
    {
      "id": 37,
      "userId": 316804150,
      "leadId": 19,
      "notes": "notes 1",
      "createdBy": 15147364,
      "createdOn": "2018-11-28T10:31:19+05:30",
      "followedUpBy": 28812689,
      "followedUpOn": "2018-10-04T12:45:00+05:30",
      "scheduledFollowUp": "2018-10-04T12:30:00+05:30"
    }
  ],
  "statusLogDetails": [
    {
      "id": 39,
      "userId": 316804150,
      "leadId": 19,
      "status": "OPEN",
      "createdBy": 15147364,
      "createdOn": "2018-11-28T10:31:19+05:30",
      "reasonId": 1,
      "reason": "not available"
    }
  ],
  "orgSourceId": -1,
  "extendedFields": {
    "trial_status": "Not Done"
  }
}