Skip to Content
1MSG
ReferenceCampaigns API

Создать сегмент

POST
/api/v1/campaigns/segments

name обязателен, до 200 символов. description необязателен, до 2000 символов. Возвращает id сегмента — он нужен при создании рассылки.

Authorization

bearer
headerAuthorizationBearer <API key>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Request Body

application/json
  1. body
name*string

Название сегмента, до 200 символов.

description?string

Необязательная заметка, до 2000 символов.

Response Body

application/json
  1. response
id*string

id сегмента.

name*string

Название сегмента, до 200 символов.

description*|

Необязательная заметка, до 2000 символов, или null, если её нет.

createdAt*string

Когда создан сегмент.

Formatdate-time
Example Request
curl -X POST 'https://api.1msg.io/api/v1/campaigns/segments' \  -H 'Content-Type: application/json' \  -d '{  "name": "April buyers"}'
Example Response201
{  "id": "cm3segment01",  "name": "April buyers",  "description": "People who bought in April",  "createdAt": "2026-11-01T09:00:00.000Z"}