Skip to content
Permalink
Browse files

2019 updates

  • Loading branch information...
seamusabshere committed Apr 19, 2019
1 parent 18a39de commit 45eacf006eff6e1e2c1247a56f380d3f1cd6c446
Showing with 6 additions and 6 deletions.
  1. +6 −6 readme.md
@@ -1,17 +1,16 @@
## API documentation

**Base URL:** `https://api.faraday.io/v3`
**Base URL:** `https://api.faraday.io`

### Households: data append and segment membership

#### Endpoint

`POST /households`
`POST /v3/households`

#### Response codes

* **200** OK
* **404** Household could not be found

#### Request parameters

@@ -47,6 +46,7 @@

#### Response

* `email` _String_ — Passed through from request.
* `person_first_name` _String_ — Passed through from request.
* `person_last_name` _String_ — Passed through from request.
* `house_number_and_street` _String_ — Normalized from request.
@@ -65,12 +65,11 @@

#### Endpoint

`POST /scores`
`POST /v3/scores`

#### Response codes

* **200** OK
* **422** Household could not be found

#### Request parameters

@@ -107,6 +106,7 @@

#### Response

* `email` _String_ — Passed through from request.
* `person_first_name` _String_ — Passed through from request.
* `person_last_name` _String_ — Passed through from request.
* `house_number_and_street` _String_ — Normalized from request.
@@ -122,4 +122,4 @@

## Copyright

Copyright 2018 Faraday
Copyright 2019 Faraday

0 comments on commit 45eacf0

Please sign in to comment.
You can’t perform that action at this time.