SLSmartletter API

Segments

Your newsletters (segments) and their topics.

get/segments— List newsletters (segments)

Keys: full_access

Query parameters

limitinteger1–100, default 20.
afteruuidId of the last item of the previous page (older items).
beforeuuidId of the first item of the previous page (newer items).
curl -X GET https://api.smartletter.ai/segments \
  -H "Authorization: Bearer $SMARTLETTER_API_KEY"

Response 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "segment",
      "id": "2d9e4b11-0000-4000-8000-000000000003",
      "name": "Acme Weekly",
      "slug": "acme-weekly"
    }
  ]
}

post/segments— Create a newsletter (segment)

Keys: full_access

Body

namerequiredstring
slugrequiredstring
languagestring
descriptionstring
themesstring[]
curl -X POST https://api.smartletter.ai/segments \
  -H "Authorization: Bearer $SMARTLETTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme Weekly","slug":"acme-weekly","language":"en"}'

Response 201

{
  "object": "segment",
  "id": "2d9e4b11-0000-4000-8000-000000000003",
  "name": "Acme Weekly",
  "slug": "acme-weekly"
}

get/topics— List topics

Keys: full_access

Query parameters

segment_idrequireduuid
curl -X GET https://api.smartletter.ai/topics \
  -H "Authorization: Bearer $SMARTLETTER_API_KEY"

Response 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "topic",
      "id": "5b1f2c90-0000-4000-8000-000000000002",
      "segment_id": "2d9e4b11-0000-4000-8000-000000000003",
      "name": "AI tools"
    }
  ]
}