Skip to main content
POST
/
list
Create list
curl --request POST \
  --url https://api.sendx.io/api/v1/rest/list \
  --header 'Content-Type: application/json' \
  --header 'X-Team-ApiKey: <api-key>' \
  --data '
{
  "name": "Premium Members"
}
'
{
  "id": "list_OcuxJHdiAvujmwQVJfd3ss",
  "name": "Newsletter Subscribers",
  "type": 123,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}
🎯 Use Cases:
  • Newsletter subscribers
  • Customer segments
  • Lead capture lists
  • Event registrations

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Body

application/json
​
name
string
required

List name

Example:

"Newsletter Subscribers"

Response

✅ List created successfully

​
id
string
Example:

"list_OcuxJHdiAvujmwQVJfd3ss"

​
name
string
Example:

"Newsletter Subscribers"

​
type
integer

List type.

Values:

  • 0 - Regular list (single opt-in)
  • 1 - Double opt-in list (requires email confirmation)
​
created
string<date-time>
​
updated
string<date-time>