{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Endpoints subpackage_activities subpackage_leads API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_leads",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Leads",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/lead/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "_limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return."
              },
              {
                "name": "_skip",
                "value": "",
                "type": "query",
                "description": "Number of results to skip before returning, for pagination."
              },
              {
                "name": "_fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include in the response."
              }
            ]
          },
          "docs": "List Leads"
        },
        {
          "info": {
            "name": "Create a new lead",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.close.com/api/v1/lead/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Contacts, addresses, and custom fields can all be nested in the lead. Activities, tasks, and opportunities must be posted separately.\n\n**status / status_id** (optional): Post either `status` or `status_id` (but not both). If neither is provided, the organization's default (first) status will be used. Using `status_id` is recommended so that users can rename statuses in the UI without breaking your implementation.\n\n**custom.FIELD_ID** (optional): Set custom fields by setting `custom.FIELD_ID` to "
        },
        {
          "info": {
            "name": "Merge two leads",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.close.com/api/v1/lead/merge/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "For details and definitions of 'source' and 'destination', see the Merge Leads feature in the UI."
        },
        {
          "info": {
            "name": "Get a single Lead",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/lead/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "_fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include in the response."
              }
            ]
          },
          "docs": "Get a single Lead"
        },
        {
          "info": {
            "name": "Update an existing lead",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.close.com/api/v1/lead/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Supports non-destructive patches. Nested `contacts` cannot be updated through this endpoint -- use the Contacts API instead.\n\n**status**: See `status` and `status_id` guidance on the create endpoint.\n\n**custom.FIELD_ID** (optional): See `custom.FIELD_ID` guidance on the create endpoint. You can also unset a single field, e.g.:\n\n```json\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c\": null }\n```\n\nIf the custom field accepts multiple values, you can specify `.add` or `.remove` as part of"
        },
        {
          "info": {
            "name": "Delete a lead",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.close.com/api/v1/lead/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a lead"
        }
      ]
    }
  ],
  "bundled": true
}