Submit person records for enhancement | DonorAtlas Partners API

curl -X POST https://api.donoratlas.com/v1/partners/enhancements \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "persons": [
    {
      "name": {
        "first": "John",
        "last": "Smith",
        "middle": "A"
      },
      "tracking_id": "person_12345",
      "addresses": [
        "123 Main St, Boston, MA 02101"
      ],
      "emails": [
        "john.smith@example.com"
      ],
      "phones": [
        "5551234567"
      ],
      "employers": [
        "Acme Corporation"
      ],
      "schools": [
        "Harvard University"
      ]
    }
  ]
}'

{
  "enhancements": {
    "contact_12345": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
  },
  "meta": {
    "requested": 10,
    "processed": 10,
    "enhancements_charged": 10,
    "enhancements_remaining": 990,
    "partial": false
  }
}

Submit a list of person records to enhance with DonorAtlas data. Maximum: 100 person records per request. For larger batches, split them into multiple requests.

Authentication

x-api-keystring

Your DonorAtlas API key. Contact support@donoratlas.com to get started.

Request

This endpoint expects an object.

personslist of objectsRequired

The person records to enhance

Response

Successful Response

enhancementsmap from strings to strings

A mapping from your tracking IDs to DonorAtlas enhancement IDs

metaobject

Metadata about the request

Errors

422

Unprocessable Entity Error

$	curl -X POST https://api.donoratlas.com/v1/partners/enhancements \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"persons": [
>	{
>	"name": {
>	"first": "John",
>	"last": "Smith",
>	"middle": "A"
>	},
>	"tracking_id": "person_12345",
>	"addresses": [
>	"123 Main St, Boston, MA 02101"
>	],
>	"emails": [
>	"john.smith@example.com"
>	],
>	"phones": [
>	"5551234567"
>	],
>	"employers": [
>	"Acme Corporation"
>	],
>	"schools": [
>	"Harvard University"
>	]
>	}
>	]
>	}'

1	{
2	"enhancements": {
3	"contact_12345": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
4	},
5	"meta": {
6	"requested": 10,
7	"processed": 10,
8	"enhancements_charged": 10,
9	"enhancements_remaining": 990,
10	"partial": false
11	}
12	}