Skip to Content
1MSG
ReferenceCampaigns API

Добавить участников в сегмент

POST
/api/v1/campaigns/segments/{segmentId}/members

members — непустой список. У каждого участника обязателен name. phone — в формате E.164 или не передаётся. bsuid — id у провайдера, например ab.abc123xyz, или не передаётся. Нужен phone или bsuid. Повтор телефона или BSUID в сегменте отклоняется. В сегменте может быть не больше 500 участников.

Authorization

bearer
headerAuthorizationBearer <API key>

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

Path Parameters

segmentId*string

id сегмента из ответа на создание или из списка.

Request Body

application/json
  1. body
members*array<>

Непустой список. У каждого участника нужны name и телефон или BSUID. Повтор телефона или BSUID в сегменте отклоняется. В сегменте может быть не больше 500 участников.

Response Body

application/json
  1. response
items*array<>

Участники, записанные этим запросом.

Example Request
curl -X POST 'https://api.1msg.io/api/v1/campaigns/segments/string/members' \  -H 'Content-Type: application/json' \  -d '{  "members": [    {      "name": "Ana"    }  ]}'
Example Response201
{  "items": [    {      "id": "cm3member01",      "name": "Ana",      "phone": "+15551234567",      "bsuid": "ab.abc123xyz"    }  ]}