Endpoint Leads

User Guide  /  API Documentation

Check out all the details about Enterprised Cloud API Endpoint Leads:

List Leads

Request Method GET

API Endpoint /wp-json/ndpv/v1/leads

Response Status Code 200 OK

{
  "success": true,
  "data": {
    "result": [
      {
        "id": 3534,
        "budget": "15000",
        "currency": "USD",
        "note": "",
        "desc": "Client has been a loyal customer for over 2 years and has made multiple purchases during this time. They have shown interest in our newest product line and have mentioned a potential large order in the future. Client is located in the Midwest and has been easy to work with in all interactions.\"",
        "level_id": {
          "id": 11,
          "label": "Cold",
          "color": "#4B6EFE",
          "bg_color": "#E7ECFE"
        },
        "tags": [
          {
            "id": 17,
            "label": "Development"
          },
          {
            "id": 51,
            "label": "Frontend"
          },
          {
            "id": 52,
            "label": "UX"
          }
        ],
        "person": {
          "id": 3533,
          "first_name": "Redwan Karim",
          "org_id": "",
          "org_name": "",
          "email": "themenfoo@gmail.com",
          "mobile": "+1 416-861-9911",
          "img": {
            "id": "3538",
            "src": "https://example.com/wp-content/uploads/2023/04/Group-19.png"
          }
        },
        "org": null,
        "date": "April 2, 2023"
      },
    ],
    "extra": {
      "custom_field": []
    },
    "total": 1
  }
}

Create Lead

Request Method POST

API Endpoint /wp-json/ndpv/v1/leads

Request Payload application/json

• budget: Float OPTIONAL
• currency: String (USD, BDT etc) OPTIONAL
• custom_field: Array OPTIONAL
• date: Date | false OPTIONAL
• desc: Longtext OPTIONAL
• email: String OPTIONAL
• first_name: String REQUIRED
• id: Null
• img: String OPTIONAL
• level_id: Integer OPTIONAL
• mobile: String OPTIONAL
• note: Longtext OPTIONAL
• org_id: Null
• org_name: String OPTIONAL
• person_id: Null
• source_id: Integer OPTIONAL
• tab_id: Integer OPTIONAL
• tags: Array of Integer OPTIONAL
• web: String OPTIONAL
• ws_id: String OPTIONAL

{
	"budget": "6500",
	"currency": "USD",
	"date": false,
	"desc": "Giusseddin needs menu design services to create a cohesive and visually appealing menu that reflects their brand and food offerings. They want the design to be simple and easy to read, with mouth-watering photos of their menu items.",
	"email": "hellonurency@gmail.com",
	"first_name": "Giusseddin",
	"id": null,
	"img": "",
	"level_id": "9",
	"mobile": "+49 30 3001950",
	"note": "Company A needs a redesign of their logo and branding materials to reflect a more modern and professional image.",
	"org_id": null,
	"org_name": "Giusseddin LLC",
	"person_id": null,
	"source_id": "",
	"tags": [
		58,
		"16",
		"52"
	],
	"web": ""
}

Response Status Code 200 OK

{
	"success": true,
	"data": 3555
}

Read Lead

Request Method GET

API Endpoint /wp-json/ndpv/v1/leads/{LEAD_ID}

Query String Parameters

• LEAD_ID

Response Status Code 200 OK

{
  "success": true,
  "data": {
    "id": 3536,
    "ws_id": "7",
    "tab_id": 3536,
    "budget": "",
    "currency": "USD",
    "note": "",
    "desc": "",
    "custom_field": [],
    "level_id": {
      "id": 53,
      "label": "VIP",
      "color": "#301313",
      "bg_color": "#f16063"
    },
    "source_id": "",
    "tags": [
      {
        "id": 54,
        "label": "Customer Support"
      },
      {
        "id": 17,
        "label": "Development"
      }
    ],
    "person": {
      "id": 3535,
      "first_name": "Emily Jacson",
      "org_id": "",
      "org_name": "",
      "email": "emily.jackson@aol.com",
      "mobile": "",
      "img": {
        "id": "3537",
        "src": "https://example.com/wp-content/uploads/2023/04/Group-2.png"
      },
      "web": "",
      "country": "",
      "region": "",
      "address": ""
    },
    "org": null,
    "date": false
  }
}

Update Lead

Request Method PUT

API Endpoint /wp-json/ndpv/v1/leads/{LEAD_ID}

Query String Parameters

• LEAD_ID

Request Payload application/json

• budget: Float OPTIONAL
• currency: String (USD, BDT etc) OPTIONAL
• custom_field: Array OPTIONAL
• date: Date | false OPTIONAL
• desc: Longtext OPTIONAL
• email: String OPTIONAL
• first_name: String REQUIRED
• id: Integer REQUIRED
• img: String OPTIONAL
• level_id: Integer OPTIONAL
• mobile: String OPTIONAL
• note: Longtext OPTIONAL
• org_id: Integer OPTIONAL
• org_name: String OPTIONAL
• person_id: Integer OPTIONAL
• source_id: Integer OPTIONAL
• tab_id: Integer OPTIONAL
• tags: Array of Integer OPTIONAL
• web: String OPTIONAL
• ws_id: String OPTIONAL

{
    "id":3532,
    "first_name":"Akeob Roma",
    "email":"akeob@romanto.com"
}

Response Status Code 200 OK

{
  "success": true,
  "data": 3532
}

Delete Lead

Request Method DELETE

API Endpoint /wp-json/ndpv/v1/leads/{LEAD_ID}

Query String Parameters

• LEAD_ID

Response Status Code 200 OK

{
	"success":true,
	"data":["3552"]
}