Create a sequence

POST/api/v2/sequences

Returns 201.

Needs an API key with the newsletter scope. Scopes

Parameters

Body

namestringrequired

The sequence's name.

list_idstringrequired

The list whose new subscribers are enrolled.

triggerstringdefault subscribe

subscribe (the default and only value).

Notes

trigger defaults to subscribe, the only trigger: people are enrolled when they become active on the list.

curl -X POST "https://api.koltrix.com/api/v2/sequences" \
  -H "Authorization: Bearer $KOLTRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Welcome series",
  "list_id": "0b3c6d2e-91f4-4a7b-8c5d-2e3f4a5b6c7d",
  "trigger": "subscribe"
}'

const res = await fetch("https://api.koltrix.com/api/v2/sequences", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KOLTRIX_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Welcome series",
    "list_id": "0b3c6d2e-91f4-4a7b-8c5d-2e3f4a5b6c7d",
    "trigger": "subscribe"
  }),
});

console.log(res.status, await res.json());

import os, requests

res = requests.post(
    "https://api.koltrix.com/api/v2/sequences",
    headers={
        "Authorization": f"Bearer {os.environ['KOLTRIX_API_KEY']}",
    },
    json={
        "name": "Welcome series",
        "list_id": "0b3c6d2e-91f4-4a7b-8c5d-2e3f4a5b6c7d",
        "trigger": "subscribe"
    },
)
print(res.status_code, res.json())

package main

import (
	"strings"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := strings.NewReader(`{
  "name": "Welcome series",
  "list_id": "0b3c6d2e-91f4-4a7b-8c5d-2e3f4a5b6c7d",
  "trigger": "subscribe"
}`)
	req, _ := http.NewRequest("POST", "https://api.koltrix.com/api/v2/sequences", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KOLTRIX_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

<?php

$ch = curl_init("https://api.koltrix.com/api/v2/sequences");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("KOLTRIX_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "name" => "Welcome series",
        "list_id" => "0b3c6d2e-91f4-4a7b-8c5d-2e3f4a5b6c7d",
        "trigger" => "subscribe",
    ]),
]);

$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response;

Created.

{
  "id": "3a2b1c0d-9e8f-4a7b-b6c5-d4e3f2a1b0c9",
  "list_id": "0b3c6d2e-91f4-4a7b-8c5d-2e3f4a5b6c7d",
  "name": "Welcome series",
  "trigger": "subscribe",
  "active": true,
  "step_count": 0,
  "created_at": "2026-10-02T12:00:00Z",
  "updated_at": "2026-10-02T12:00:00Z"
}

A required field is missing or invalid. The text names the problem.

{
  "error": "name is required"
}

The API key is missing, malformed, unknown or revoked.

{
  "error": "invalid or revoked api key"
}

The key is valid but does not have the newsletter scope.

{
  "error": "missing permission: newsletter"
}

More than 60 requests a minute on this key. Wait Retry-After seconds. No code field.

Retry-After: 60

{
  "error": "rate limit exceeded — 60 requests per minute per API key"
}

Try it below with your own key. Every sample reads the key from KOLTRIX_API_KEY.

Try it

Send this request from your browser.

Input

What you send

API key

Stays in this browser tab (sessionStorage) and goes only to api.koltrix.com. Create one under Settings → API keys.

Requests are real and this one changes data in your workspace. Koltrix has no test mode, so use a dedicated key with only the permissions you need and revoke it when you are done.

namestringrequired

list_idstringrequired

triggerstring

Request body · JSON

Valid JSON. The fields above and this editor stay in sync.

POSThttps://api.koltrix.com/api/v2/sequences

Output

What comes back

The response appears here.
Press Send request.