Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Leads

Create a lead

Creates a lead with desired params.

post/v2/leads

Request body

OR
OR

Example request

{
  "amount": 25000,
  "external_key": "361ba21c-ca87-46b0-baa4-97ca16e55059",
  "fields": [
    {
      "field_key": "field_fjkdlrh9i32nfew",
      "name": "Company Address"
    }
  ],
  "meta": {
    "company": "Lockman Olson",
    "email": "River96@example.com",
    "first_name": "River",
    "last_name": "Tremblay"
  },
  "partner_key": "bertramgilfoyle",
  "stage_api_name": "crm_stage_123",
  "status": "open"
}

Response

Creates a lead with desired params.

messagestring required
statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399,
    "amount": 25000,
    "customer_key": "cus_1234",
    "external_key": "361ba21c-ca87-46b0-baa4-97ca16e55059",
    "fields": [
      {
        "field_key": "field_fjkdlrh9i32nfew",
        "name": "Company Address"
      }
    ],
    "meta": {
      "company": "Lockman Olson",
      "email": "River96@example.com",
      "first_name": "River",
      "last_name": "Tremblay"
    },
    "partner_key": "bertramgilfoyle",
    "stage_data": {
      "api_name": "closed won",
      "name": "Closed Won"
    },
    "status": "open",
    "team": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "name": "Tushar"
    },
    "team_member": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "email": "tushten@partnerstack.com",
      "first_name": "Tushar",
      "last_name": "Sutherland",
      "personal_stack_key": "stck_1234567890"
    }
  }
}