Sign in

Create a Recipient List

documented

Create a new recipient list with recipients and metadata.

POST /api/v1/recipient-listsSendingno implementation yet0 runs
No implementation yet. Run it to have the agent write one, or open a pull request with your own.

Seed example (keychains curl)

npx -y keychains@latest curl "https://api.sparkpost.com/api/v1/recipient-lists?num_rcpt_errors={{$num_rcpt_errors}}" \
  -X POST \
  -H "Authorization: {{SPARKPOST_API_KEY}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id": "{{$id}}", "name": "{{$name}}", "description": "{{$description}}", "attributes": {"internal_id": {{$internal_id}}, "list_group_id": {{$list_group_id}}}, "recipients": [ {"address": {"email": "{{$recipient_email}}", "name": "{{$recipient_name}}"}, "tags": ["{{$tag1}}", "{{$tag2}}"], "metadata": {"age": "{{$age}}", "place": "{{$place}}"}, "substitution_data": {"favorite_color": "{{$favorite_color}}", "job": "{{$job}}"} } ] }'