Skip to content

Create a New Lead

POST https://api.prosperworks.com/developer_api/v1/leads

Request body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "name":"My Lead",
  "email": {
    "email":"mylead@noemail.com",
    "category":"work"
  },
  "phone_numbers": [
    {
      "number":"415-123-45678",
      "category":"mobile"

    }
  ],
  "address": {
    "street": "123 Main Street",
    "city": "Savannah",
    "state": "Georgia",
    "postal_code": "31410",
    "country": "United States"
  },
  "custom_fields": [
    {
      "custom_field_definition_id": 100764,
      "value": "Text fields are 255 chars or less!"
    },
    {
      "custom_field_definition_id": 103481,
      "value": "Text area fields can have long text content"
    }
  ],
  "customer_source_id":331242
}

Example Requests

Create new Lead

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"name\":\"My Lead\",
  \"email\": {
    \"email\":\"mylead@noemail.com\",
    \"category\":\"work\"
  },
  \"phone_numbers\": [
    {
      \"number\":\"415-123-45678\",
      \"category\":\"mobile\"

    }
    ],
     \"custom_fields\": [
    {
      \"custom_field_definition_id\": 100764,
      \"value\": \"Text fields are 255 chars or less!\"
    },
    {
      \"custom_field_definition_id\": 103481,
      \"value\": \"Text area fields can have long text content\"
    }
    ],
    \"customer_source_id\":331242
}"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "id": 13244480,
  "name": "My Lead",
  "prefix": null,
  "first_name": "My",
  "last_name": "Lead",
  "middle_name": null,
  "suffix": null,
  "address": null,
  "assignee_id": null,
  "company_name": null,
  "customer_source_id": 331242,
  "details": null,
  "email": {
    "email": "mylead@noemail.com",
    "category": "work"
  },
  "interaction_count": 0,
  "monetary_value": null,
  "socials": [],
  "status": "New",
  "status_id": 208231,
  "tags": [],
  "title": null,
  "websites": [],
  "phone_numbers": [
    {
      "number": "415-123-45678",
      "category": "mobile"
    }
  ],
  "custom_fields": [
    {
      "custom_field_definition_id": 100764,
      "value": "Text fields are 255 chars or less!"
    },
    {
      "custom_field_definition_id": 103481,
      "value": "Text area fields can have long text content"
    },
    {
      "custom_field_definition_id": 128735,
      "value": null
    }
  ],
  "date_created": 1502158444,
  "date_modified": 1502158444,
  "date_last_contacted": null
}