Skip to content

Retrieving a list of test-mail-groups

GET /integrations/inxmail-professional/mailing-sychronizations/{id}/test-mail-groups

Request Parameters

Parameter Required In Description
id yes path The ID of the Mailing Synchronization the test-mail-groups should be retrieved for

Response Structure

Path Type Description
id Number The ID of the test-mail-group
name String The name of the test-mail-group
emails Array\<String> List of e-mail addresses

Basic Example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/0fa76c13-172f-454a-a014-04a91028f6ce/test-mail-groups' -i -X GET \
    -H 'Authorization: Basic <base64Encoded user:password>'

Response:

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...

{
   "_embedded" : {
      "inx:test-mail-groups" : [
         {
            "emails" : [
               "test-mail-001@example.invalid",
               "test-mail-002@example.invalid"
            ],
            "id" : 1,
            "name" : "Test-Mail-Group-001"
         }
      ]
   },
   "_links" : {
      "curies" : [
         {
            "href" : "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
            "name" : "inx",
            "templated" : true
         }
      ],
      "self" : {
         "href" : "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/0fa76c13-172f-454a-a014-04a91028f6ce/test-mail-groups"
      }
   }
}
Back to top