1MSG
ReferenceCampaigns API

Update a segment

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

Send only the fields that change. name up to 200 characters. description up to 2000 characters. segmentId is the id from create.

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.

Request Body

application/json
  1. body
name?string

New name, up to 200 characters. Send only the fields that change.

description?string

New note, up to 2000 characters.

Response Body

application/json
  1. response
id*string

Segment id.

name*string

Segment name, up to 200 characters.

description*|

Optional note, up to 2000 characters, or null when none was stored.

memberCount*number

How many people are in the segment.

createdAt*string

When the segment was created.

Formatdate-time
updatedAt*string

When the segment was last updated.

Formatdate-time
curl -X PATCH 'https://api.1msg.io/api/v1/campaigns/segments/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "cm3segment01",  "name": "April buyers",  "description": "string",  "memberCount": 12,  "createdAt": "2026-11-01T09:00:00.000Z",  "updatedAt": "2026-11-01T09:00:00.000Z"}