1MSG
ReferenceCampaigns API

Update one segment member

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

Send only the fields that change. phone must stay E.164. bsuid must stay in the provider format. The member still needs a phone or a BSUID after the update.

Authorization

bearer
headerAuthorizationBearer <token>

Key issued in Settings → Developer → API key. Inbox methods need the Inbox scope. Campaigns methods need the Campaigns scope.

Path Parameters

segmentId*string

Segment id returned by create or list.

memberId*string

Member id returned by the member list.

Request Body

application/json
  1. body
name?string

New name, up to 200 characters.

phone?string

E.164 phone, for example +15551234567. After the update the member still needs a phone or a BSUID.

bsuid?string

Provider BSUID, for example ab.abc123xyz. A trailing @lid is stored without it.

Response Body

application/json
  1. response
id*string

Member id.

name*string

Member name.

phone*|

Phone in E.164, or null when the member is stored by BSUID.

bsuid*|

Provider BSUID without a trailing @lid, or null when the member is stored by phone.

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