Create an empty segment
Request
Parameter |
In |
Type |
Required |
Description |
---|---|---|---|---|
|
header |
string |
true |
Determines the expected format and data type to retrieve the response data. Value: |
|
path |
string |
true |
The ID of the email list where the segment is created. |
|
path |
string |
true |
The supported file format for getting a response. Possible values: |
|
query |
string |
true |
The API key of your account. |
|
body |
string |
true |
The name of the segment. |
|
body |
string |
false |
Specifies how subscribers are returned by your segment based on matching criteria:
|
|
body |
string |
false |
Specifies how many criteria-matching subscribers are contained in your segment:
|
|
body |
integer |
false |
Specifies the maximum number for |
POST https://{hostname}/v3/lists/{MailingListID}/segments/create.{Format}?apikey=
Request body:
{
"Name": "New Customers",
"MatchType": "All",
"FetchType": "Top",
"FetchValue": "200"
}
Response
Status |
Description |
Headers |
Schema |
---|---|---|---|
|
The request is successful. |
|
N/A |
{
"Code": 0,
"Error": null,
"Context": 10199
}
-
Code
- the response code. This is0
if successful. -
Error
- the response error message. This isnull
if successful. -
Context
- the ID of the segment created.