Lists
Create a list
POST
/listsA new, empty list. Names can repeat, as in the app; send an Idempotency-Key to retry safely.
Try itSend a real request with your API key
Headers
Idempotency-KeystringAny unique value up to 255 characters, like a UUID. The request runs once; repeats within 24 hours get the first answer, with Idempotent-Replayed: true. Up to 255 characters.
Body
namestringRequiredUp to 100 characters.
Answer
201 Created The new list.
dataListRequiredInside it
idstringRequiredList ID.
namestringRequiredcreatedAtstring · date-timeRequiredleadsintegerRequiredPeople in the list.
campaignsarray of objectRequiredCampaigns that take people from this list.
Each item
idstringRequirednamestringRequiredstatusstringRequireddraft: not launched. active: running. paused: stopped by the owner. completed: finished. One of
draft,active,paused,completed.
Errors
- 400 Bad request
invalid_requestinvalid_jsonduplicate_in_request - 401 Unauthorized
unauthorized - 404 Not found
not_foundnot_in_campaign - 409 Conflict
conflictidempotency_in_progressworkspace_busycampaign_finishedcampaign_without_listtag_limitlead_has_historycampaign_not_launchedcampaign_cannot_resumeambiguous_email - 413 Too large
too_large - 415 Wrong content type
unsupported_media_type - 422 Can’t process
idempotency_key_reused - 429 Too many requests
rate_limited - 500 Server error
server_error
Every error has the same shape. See Errors.