Skip to main content
POST
Create a Segment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

The name of the segment.

code
string

The code that identifies the record.

communicationId
string

The identifier of the communication this record belongs to.

description
string

A free-text description of the record.

totalContacts
string

The number of contacts the segment was sent to.

contactQueryId
string

The identifier of the saved contact query that defines the segment.

costPerContact
string

The cost of reaching one contact in the segment.

packageCode
string

The code that identifies the package used for the segment.

packageDescription
string

A description of the package used for the segment.

receiptSegmentId
string

The identifier of the segment used when receipting the gift, when it differs from the gift segment.

segmentOrganizerId
string

The identifier of the segment organizer this segment belongs to.

Response

OK

id
string

The unique identifier of the record in Virtuous.

name
string

The display name of the record.

description
string

The free-text description stored on the record.

code
string
communicationId
string
communicationName
string
campaignId
string
campaignName
string
segmentOrganizerId
string
Last modified on April 23, 2026