Skip to main content
PUT
Update a Segment
Change its name, description, code, externalIdentifier, or the campaignId it belongs to. Returns the updated segment.
Check a new code with Check if Segment Exists first.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

id
integer<int64>
required

The ID of the segment.

Body

The segment request model.

campaignId
integer<int64>
required

The unique identifier of the campaign the segment belongs to.

name
string
required

The name of the segment.

Minimum string length: 1
code
string
required

The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free.

Minimum string length: 1
description
string | null

The description of the segment.

externalIdentifier
string | null

An identifier of your own to store on the segment, for reconciling it with an external system.

Response

OK

Represents a segment model.

id
integer<int64>

The unique identifier of the segment.

campaignId
integer<int64>

The unique identifier of the campaign.

campaignName
string | null

The name of the campaign.

name
string | null

The name of the segment.

description
string | null

The description of the segment.

code
string | null

The code of the segment.

externalIdentifier
string | null

An identifier of your own to store on the segment, for reconciling it with an external system.

totalDonors
integer<int32>
read-only

The number of donors who have given to the segment.

totalGifts
integer<int32>
read-only

The number of gifts recorded for the segment.

totalGiftAmount
string | null
read-only

The total amount of the gifts recorded for the segment.

averageGiftAmount
string | null
read-only

The average gift amount for the segment.

medianGiftAmount
string | null
read-only

The median gift amount for the segment.

highestGiftAmount
string | null
read-only

The largest gift amount for the segment.

totalVisitors
integer<int32>
read-only

The number of visitors recorded for the segment.

conversionRate
string | null
read-only

The share of visitors to the segment who gave.

createdDateTime
string | null
read-only

The UTC date and time the segment was created.

modifiedDateTime
string | null
read-only

The UTC date and time the segment was last modified.

Last modified on July 28, 2026