POST api/v1/Segments/ContactIds

Creates a segment based on a list of contactIds

Request Information

URI Parameters

None.

Body Parameters

SegmentContactIdsDto
NameDescriptionTypeAdditional information
FolderId

Id of the folder where the segment is placed

integer

None.

Name

Name of Segment

string

None.

Description

Description of Segment

string

None.

ContactIds

List of contactIds to include in Segment

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "FolderId": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ContactIds": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SegmentDto
NameDescriptionTypeAdditional information
Id

Id of Segment

integer

None.

Name

Name of Segment

string

None.

FolderId

Id of the folder where the segment is placed

integer

None.

Type

Type of Segment

SegmentType

None.

Description

Description of Segment

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "FolderId": 3,
  "Type": "VisualBuilder",
  "Description": "sample string 4"
}