Create a Segment
Creates a segment to track giving within a campaign.
campaignId, a name, and the code you will use to attribute gifts to it, plus an externalIdentifier if you match segments to records in another system. Returns the created segment with its new id.Authorizations
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Body
The segment request model.
The unique identifier of the campaign the segment belongs to.
The name of the segment.
1The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free.
1The description of the segment.
An identifier of your own to store on the segment, for reconciling it with an external system.
Response
OK
Represents a segment model.
The unique identifier of the segment.
The unique identifier of the campaign.
The name of the campaign.
The name of the segment.
The description of the segment.
The code of the segment.
An identifier of your own to store on the segment, for reconciling it with an external system.
The number of donors who have given to the segment.
The number of gifts recorded for the segment.
The total amount of the gifts recorded for the segment.
The average gift amount for the segment.
The median gift amount for the segment.
The largest gift amount for the segment.
The number of visitors recorded for the segment.
The share of visitors to the segment who gave.
The UTC date and time the segment was created.
The UTC date and time the segment was last modified.