ReplySparrow Docs

Lists

Create a list

Create a new, empty list in the workspace. The list is the link between a source agent (which imports the leads it finds into the list) and a campaign (which reaches out to the contacts of the list). Creating the list is the first step of setting up an agent from the API: create the list, then the source agent (POST /api/v1/agents), then the campaign (POST /api/v1/campaigns). With campaign_id, the list is also attached to that campaign: contacts you add to it are picked up by the campaign's agent and enrolled. Needs the campaigns:write scope.

posthttps://app.replysparrow.com/api/v1/lists

Authorizations

Authorizationstringheaderrequired

Your API key from Settings → API, sent as Bearer <token>.

Body

application/json
namestringrequired

Response

application/json

List created

idstringrequired

Unique identifier for the list

namestringrequired

Name of the list

contact_countnumberrequired

Contacts in the list

campaign_idstringrequired

Campaign associated with this list: the campaign whose own lead list it is, else the first campaign it is attached to; null when no campaign uses it

campaignobjectrequired

Associated campaign (the one in campaign_id)

campaignsobject[]required

Every campaign using the list: as its own lead list, or attached to reach its contacts

custom_fieldsobject[]required

Custom field definitions with values for this list's contacts

created_atstring<date-time>required

Creation timestamp

Description

Create a list
curl --request POST \  --url https://app.replysparrow.com/api/v1/lists \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "name": "Webinar attendees",  "description": "October webinar",  "campaign_id": "5b0c6c1e-8a43-4f7e-9d7d-1f8a2b3c4d5e"}'
{  "id": "9f8e7d6c-0000-4000-8000-000000000002",  "name": "Webinar attendees",  "description": "October webinar",  "contact_count": 0,  "campaign_id": "5b0c6c1e-8a43-4f7e-9d7d-1f8a2b3c4d5e",  "campaign": {    "id": "5b0c6c1e-8a43-4f7e-9d7d-1f8a2b3c4d5e",    "name": "Q4 founders"  },  "campaigns": [    {      "id": "5b0c6c1e-8a43-4f7e-9d7d-1f8a2b3c4d5e",      "name": "Q4 founders"    }  ],  "custom_fields": [],  "created_at": "2026-10-01T08:00:00.000Z"}