Create a new person list | WealthAtlas Partners API

Create a new person list for the team. Optionally populate it with person IDs on creation. List names must be unique within a team.

Cost: Free to create an empty list. 1 credit per person added on creation.

Authentication

x-api-keystring

Your WealthAtlas API key. Contact support@wealthatlas.com to get started.

Request

This endpoint expects an object.

list_namestringRequired1-255 characters

Name for the new list (must be unique within the team)

person_idslist of strings or nullOptional

Optional list of WealthAtlas person IDs to add to the list on creation

Response

Successful Response

list_idstring

ID of the newly created list

list_namestring

Name of the newly created list

successful_idslist of stringsOptional

Person IDs that were successfully added to the list

failed_idslist of stringsOptional

Person IDs that could not be added because their write failed. Credits for these are refunded. IDs that are in neither list were dropped for insufficient credits

Errors

402

Payment Required Error

409

Conflict Error

422

Unprocessable Entity Error

$	curl -X POST https://api.wealthatlas.com/v1/partners/lists \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"list_name": "Major Donors 2024"
>	}'

1	{
2	"list_id": "string",
3	"list_name": "string",
4	"successful_ids": [
5	"string"
6	],
7	"failed_ids": [
8	"string"
9	]
10	}