API ReferenceLists

Create a new donor list

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

Cost: 1 credit.

Authentication

x-api-keystring
Your DonorAtlas API key. Contact support@donoratlas.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)

donor_idslist of strings or nullOptional
Optional list of DonorAtlas donor 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 strings
Donor IDs that were successfully added to the list

Errors

402
Payment Required Error
409
Conflict Error
422
Unprocessable Entity Error