Create a contact segment

post

/api/REST/2.0/assets/contact/segment

Creates a contact segment that matches the criteria specified by the request body.

Request

Supported Media Types
Body ()
The request body defines the details of the contact segment to be created.
Root Schema : ContactSegment
Type: object
Title: ContactSegment
Show Source
Nested Schema : elements
Type: array
Array of contact segment elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact segment granted to your current instance. This is a read-only property.
Show Source
Nested Schema : SegmentElement
Type: object
Title: SegmentElement
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact segment element granted to your current instance. This is a read-only property.
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success
Body ()
Root Schema : ContactSegment
Type: object
Title: ContactSegment
Show Source
Nested Schema : elements
Type: array
Array of contact segment elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact segment granted to your current instance. This is a read-only property.
Show Source
Nested Schema : SegmentElement
Type: object
Title: SegmentElement
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact segment element granted to your current instance. This is a read-only property.
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Create a new contact segment:


POST /api/REST/2.0/assets/contact/segment
Content-Type: application/json
			

Request body:


{
  "name":"My New Segment"
}

			

Response:


{
  "type": "ContactSegment",
  "currentStatus": "Draft",
  "id": "70",
  "createdAt": "1501002060",
  "createdBy": "9",
  "depth": "complete",
  "folderId": "1267",
  "name": "My New Segment",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update"
  ],
  "updatedAt": "1501002060",
  "updatedBy": "9",
  "elements": [],
  "isStale": "True"
}
			
Back to Top