Create an email group

post

/api/REST/1.0/assets/email/group

Creates an email group that matches the criteria specified by the request body.

Request

Supported Media Types
Body ()
The request body defines the details of the email group to be created.
Root Schema : EmailGroup
Type: object
Title: EmailGroup
Show Source
Nested Schema : emailIds
Type: array
Array containing the unique identifiers of the emails in the email group.
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : EmailGroup
Type: object
Title: EmailGroup
Show Source
Nested Schema : emailIds
Type: array
Array containing the unique identifiers of the emails in the email group.
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 email group:


POST /api/REST/1.0/assets/email/group
Content-Type: application/json 
			

Request body:


{
    "depth":"minimal",
    "name":"Test Group"
}
			

Response:


{
    "type":"EmailGroup",
    "id":"18",
    "createdAt":"1432240338",
    "createdBy":"19",
    "depth":"complete",
    "name":"Test Group",
    "permissions":"fullControl",
    "updatedAt":"1432240338",
    "updatedBy":"19",
    "emailIds":[

    ],
    "isVisibleInOutlookPlugin":"false",
    "isVisibleInPublicSubscriptionList":"true",
    "subscriptionListDataLookupId":"f78c3d6d-ea9c-456c-8aae-de8778d24a6c",
    "subscriptionListId":"76",
    "unSubscriptionListDataLookupId":"724f80ef-caf4-4720-863c-fc0948d9903f",
    "unSubscriptionListId":"77"
}
			
Back to Top