Update a specific segment. | Virtuous Developer Documentation

curl -X PUT https://prod-api.raisedonors.com/api/Segment/1 \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "campaignId": 1024,
  "name": "Spring Fundraising Segment",
  "code": "SPRING2024"
}'

{
  "id": 1,
  "campaignId": 1024,
  "campaignName": "2024 Spring Campaign",
  "name": "Spring Fundraising Segment",
  "description": "Segment targeting donors active in spring 2024 campaign",
  "code": "SPRING2024",
  "externalIdentifier": "SEG-2024-SPRING",
  "totalDonors": 350,
  "totalGifts": 420,
  "totalGiftAmount": "12500.00",
  "averageGiftAmount": "29.76",
  "medianGiftAmount": "25.00",
  "highestGiftAmount": "500.00",
  "totalVisitors": 1200,
  "conversionRate": "29.17%",
  "createdDateTime": "2024-01-15T09:30:00Z",
  "modifiedDateTime": "2024-04-10T16:45:00Z"
}

Authentication

Authorizationstring

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

Path parameters

idlongRequired

The ID of the segment.

Request

The segment request model.

campaignIdlongRequired

namestringRequired>=1 character

codestringRequired>=1 character

descriptionstring or nullOptional

externalIdentifierstring or nullOptional

Response

idlongOptional

Gets or sets the identifier.

campaignIdlongOptional

Gets or sets the campaign identifier.

campaignNamestring or nullOptional

Gets or sets the campaign name.

namestring or nullOptional

Gets or sets the name.

descriptionstring or nullOptional

Gets or sets the description.

codestring or nullOptional

Gets or sets the code.

externalIdentifierstring or nullOptional

Gets or sets the external identifier.

totalDonorsintegerOptionalRead-only

Gets or sets the total donors.

totalGiftsintegerOptionalRead-only

Gets or sets the total gifts.

totalGiftAmountstring or nullOptionalRead-only

Gets or sets the total gift amount.

averageGiftAmountstring or nullOptionalRead-only

Gets or sets the average gift amount.

medianGiftAmountstring or nullOptionalRead-only

Gets or sets the median gift amount.

highestGiftAmountstring or nullOptionalRead-only

Gets or sets the highest gift amount.

totalVisitorsintegerOptionalRead-only

Gets or sets the total visitors.

conversionRatestring or nullOptionalRead-only

Gets or sets the conversion rate.

createdDateTimestring or nullOptionalRead-only

Gets or sets the created date time.

modifiedDateTimestring or nullOptionalRead-only

Gets or sets the modified date time.

Errors

400

Bad Request Error