Skip to Content
1MSG
ReferenceCampaigns API

Изменить одного участника сегмента

PATCH
/api/v1/campaigns/segments/{segmentId}/members/{memberId}

Передавайте только поля, которые меняются. phone должен остаться в формате E.164, bsuid — в формате провайдера. После изменения у участника по-прежнему должен быть телефон или BSUID.

Authorization

bearer
headerAuthorizationBearer <API key>

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

Path Parameters

segmentId*string

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

memberId*string

id участника из списка участников.

Request Body

application/json
  1. body
name?string

Новое имя, до 200 символов.

phone?string

Телефон в формате E.164, например +15551234567. После изменения у участника по-прежнему должен быть телефон или BSUID.

bsuid?string

BSUID у провайдера, например ab.abc123xyz. Окончание @lid отбрасывается при сохранении.

Response Body

application/json
  1. response
id*string

id участника.

name*string

Имя участника.

phone*|

Телефон в формате E.164 или null, если участник сохранён по BSUID.

bsuid*|

BSUID у провайдера без окончания @lid или null, если участник сохранён по телефону.

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