Update the Person with payload documentation

MadKudu · Sep 12, 2024 · 469f2d3 · 469f2d3
1 parent 9e58e39
commit 469f2d3
Showing 1 changed file with 198 additions and 9 deletions.
diff --git a/source/index.html.md b/source/index.html.md
@@ -360,7 +360,7 @@ See [Company properties](#company-properties)
 
 ## Persons (with payload)
 
-This API endpoint is similar to the one above but it lets you provide your own enriched person data.
+This API endpoint is similar to the one above but it lets you provide your own enriched person data. It's used to allow very high volume tenants to send us directly the Clearbit payload for us to score.
 
 ```json
 {
@@ -435,17 +435,206 @@ This API endpoint is similar to the one above but it lets you provide your own e
 
 `POST https://api.madkudu.com/v1/persons`
 
-### Query Parameters
+### Sample payload
 
-| Parameter | Description           |
-| --------- | --------------------- | ------------------------------------------------ |
-| email     | **string (required)** | The email of the lead you would like to retrieve |
-| person    | **object (required)** | The clearbit person object                       |
-| company   | **object (required)** | The clearbit company object                      |
+```json
+{
+  "email": "[email protected]",
+  "person": {
+    "id": "dcf17bf2-1598-4433-92ef-320201e2190a",
+    "name": {
+      "fullName": "Maxime Gaudin",
+      "givenName": "Maxime",
+      "familyName": "Gaudin"
+    },
+    "email": "[email protected]",
+    "gender": "male",
+    "location": "Mountain View, CA, US",
+    "timeZone": "America/Los_Angeles",
+    "utcOffset": -7,
+    "geo": {
+      "city": "Mountain View",
+      "state": "California",
+      "stateCode": "CA",
+      "country": "United States",
+      "countryCode": "US",
+      "lat": 37.3860517,
+      "lng": -122.0838511
+    },
+    "bio": "Co-founder at @MadKudu / @Techstars Boulder 2015. \nI love mountains, coffee and suffering.",
+    "site": "http://attackwithnumbers.com",
+    "avatar": "https://d1ts43dypk8bqh.cloudfront.net/v1/avatars/dcf17bf2-1598-4433-92ef-320201e2190a",
+    "employment": {
+      "domain": "madkudu.com",
+      "name": "MadKudu",
+      "title": "student",
+      "role": "engineering",
+      "seniority": "executive"
+    },
+    "facebook": {
+      "handle": null
+    },
+    "github": {
+      "handle": null,
+      "id": null,
+      "avatar": null,
+      "company": null,
+      "blog": null,
+      "followers": null,
+      "following": null
+    },
+    "twitter": {
+      "handle": "maxigaud",
+      "id": 16282042,
+      "bio": "",
+      "followers": 1799,
+      "following": 1567,
+      "statuses": 17904,
+      "favorites": 1551,
+      "location": "Mountain View, CA",
+      "site": "",
+      "avatar": "https://pbs.twimg.com/profile_images/615277398100066304/lx_J0fC0.png"
+    },
+    "linkedin": {
+      "handle": "in/paulcothenet"
+    },
+    "googleplus": {
+      "handle": null
+    },
+    "aboutme": {
+      "handle": null,
+      "bio": null,
+      "avatar": null
+    },
+    "gravatar": {
+      "handle": "paulkudu",
+      "urls": [
 
-### Properties
+      ],
+      "avatar": "https://secure.gravatar.com/avatar/d0c0fdb4d8869e5e2523959cd019f03b",
+      "avatars": [
+        {
+          "url": "https://secure.gravatar.com/avatar/d0c0fdb4d8869e5e2523959cd019f03b",
+          "type": "thumbnail"
+        }
+      ]
+    },
+    "fuzzy": false,
+    "emailProvider": false,
+    "indexedAt": "2018-04-09T17:26:06.533Z"
+  },
+  "company": {
+    "id": "a996c075-7bf1-4324-ad26-e59e97ba4fd2",
+    "name": "MadKudu",
+    "legalName": "MadKudu, Inc.",
+    "domain": "madkudu.com",
+    "domainAliases": [
 
-See [Person properties](#person-properties)
+    ],
+    "site": {
+      "phoneNumbers": [
+      ],
+      "emailAddresses": [
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]"
+      ]
+    },
+    "category": {
+      "sector": "Information Technology",
+      "industryGroup": "Software & Services",
+      "industry": "Internet Software & Services",
+      "subIndustry": "Internet Software & Services",
+      "sicCode": "48",
+      "naicsCode": "51"
+    },
+    "tags": [
+      "SAAS",
+      "B2B",
+      "Technology",
+      "Information Technology & Services"
+    ],
+    "description": "Helping companies grow sales by consistently generating relevant conversations with qualified leads",
+    "foundedYear": null,
+    "location": "XXX Diericx Dr, Mountain View, CA 94040, USA",
+    "timeZone": "America/Los_Angeles",
+    "utcOffset": -7,
+    "geo": {
+      "streetNumber": "13150",
+      "streetName": "Diericx Drive",
+      "subPremise": null,
+      "city": "Mountain View",
+      "postalCode": "94040",
+      "state": "California",
+      "stateCode": "CA",
+      "country": "United States",
+      "countryCode": "US",
+      "lat": 37.3695439,
+      "lng": -122.0664999
+    },
+    "logo": "https://logo.clearbit.com/madkudu.com",
+    "facebook": {
+      "handle": "682334211804512",
+      "likes": 75
+    },
+    "linkedin": {
+      "handle": "company/madkudu"
+    },
+    "twitter": {
+      "handle": "madkudu",
+      "id": "2558168940",
+      "bio": "Turn trials into sales. MadKudu analyzes what users do and who they are to find signals they are ready to convert or that they need help.",
+      "followers": 499,
+      "following": 350,
+      "location": "Mountain View, CA",
+      "site": "http://t.co/FQPmdhrlUD",
+      "avatar": "https://pbs.twimg.com/profile_images/664136410526429184/04OG2Ua3_normal.png"
+    },
+    "crunchbase": {
+      "handle": "organization/madkudu"
+    },
+    "emailProvider": false,
+    "type": "private",
+    "ticker": null,
+    "identifiers": {
+      "usEIN": "471324672"
+    },
+    "phone": "+1 650-650-6500",
+    "metrics": {
+      "alexaUsRank": null,
+      "alexaGlobalRank": 816099,
+      "employees": 10,
+      "employeesRange": "1-10",
+      "marketCap": null,
+      "raised": 1370001,
+      "annualRevenue": null,
+      "estimatedAnnualRevenue": "$1M-$10M",
+      "fiscalYearEnd": 12
+    },
+    "indexedAt": "2018-04-16T01:30:47.249Z",
+    "tech": [
+      "aws_route_53",
+      "google_cloud",
+      "optimizely",
+      "google_apps",
+      "piwik",
+      "mad_kudu",
+      "intercom",
+      "hubspot",
+      "hotjar",
+      "segment"
+    ],
+    "parent": {
+      "domain": null
+    }
+  }
+}
+```
 
 # Job changes API